Interface BooleanStateBehavior

interface BooleanStateBehavior {
    [reference]: Datasource<StateType>;
    agent: Agent;
    cluster: never;
    context: ActionContext;
    endpoint: Endpoint<Empty>;
    env: Environment;
    events: EventEmitter & Omit<Events, never> & {
        stateValue$Changing: ClusterEvents.AttributeObservable<Attribute<boolean, any>>;
    } & {} & {
        stateValue$Changed: ClusterEvents.AttributeObservable<Attribute<boolean, any>>;
    } & {} & {} & {
        stateChange?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
            stateValue: FieldType<boolean>;
        }>, any>>;
    };
    features: TypeFromBitSchema<{}>;
    session: SecureSession;
    state: Omit<{}, never> & {
        stateValue: boolean;
    } & {} & {} & {};
    [asyncDispose](): MaybePromise;
    asAdmin(fn: (() => void)): void;
    assertAttributeEnabled<This, K>(this: This, attributeName: K): void;
    callback<A, R>(reactor: Reactor<A, R>, options?: Reactor.Options): ((...args: A) => undefined | R);
    initialize(_options?: {}): MaybePromise;
    reactTo<O>(observable: O, reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>, options?: Reactor.Options): void;
    requireAttributeEnabled<This, K>(this: This, attributeName: K): Exclude<This["state"][K], undefined>;
    toString(): string;
    State: any;
}

Hierarchy (view full)

Properties

[reference] agent cluster context endpoint env events features session state

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize reactTo requireAttributeEnabled toString

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<Events, never> & {
    stateValue$Changing: ClusterEvents.AttributeObservable<Attribute<boolean, any>>;
} & {} & {
    stateValue$Changed: ClusterEvents.AttributeObservable<Attribute<boolean, any>>;
} & {} & {} & {
    stateChange?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        stateValue: FieldType<boolean>;
    }>, any>>;
}

Access the behavior's events.

Type declaration

features

features: TypeFromBitSchema<{}>

Supported features as a flag object.

session

session: SecureSession

Readonlystate

state: Omit<{}, never> & {
    stateValue: boolean;
} & {} & {} & {}

Access the behavior's state.

Type declaration

  • ReadonlystateValue: boolean

    This represents a boolean state.

    The semantics of this boolean state are defined by the device type using this cluster.

    For example, in a Contact Sensor device type, FALSE=open or no contact, TRUE=closed or contact.

    See

    MatterSpecification.v13.Cluster § 1.7.4.1

Methods

[asyncDispose]

asAdmin

assertAttributeEnabled

Protectedcallback

  • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

  • Create a generic callback function that has the same properties as a Reactor.

    Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

    Type Parameters

    • A extends any[]
    • R

    Parameters

    Returns ((...args: A) => undefined | R)

      • (...args): undefined | R

      • Parameters

        • Rest...args: A

        Returns undefined | R

initialize

  • initialize(_options?): MaybePromise

  • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

    This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

    Parameters

    • Optional_options: {}

      Returns MaybePromise

    ProtectedreactTo

    • reactTo<O>(observable, reactor, options?): void

    • Install a Reactor.

      Important: The reactor MUST be a real JS function - arrow functions will not work!

      Type Parameters

      Parameters

      Returns void

    requireAttributeEnabled

    toString

    Settings

    Member Visibility

    On This Page

    Properties
    Methods