Interface AirQualityBehavior

interface AirQualityBehavior {
    [reference]: Datasource<StateType>;
    agent: Agent;
    cluster: never;
    context: ActionContext;
    endpoint: Endpoint<Empty>;
    env: Environment;
    events: EventEmitter & Omit<Events, never> & {
        airQuality$Changing: ClusterEvents.AttributeObservable<Attribute<AirQuality.AirQualityEnum, any>>;
    } & {} & {
        airQuality$Changed: ClusterEvents.AttributeObservable<Attribute<AirQuality.AirQualityEnum, any>>;
    } & {} & {} & {};
    features: TypeFromBitSchema<{
        extremelyPoor: BitFlag;
        fair: BitFlag;
        moderate: BitFlag;
        veryPoor: BitFlag;
    }>;
    session: SecureSession;
    state: Omit<{}, never> & {
        airQuality: AirQuality.AirQualityEnum;
    } & {} & {} & {};
    [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> & {
    airQuality$Changing: ClusterEvents.AttributeObservable<Attribute<AirQuality.AirQualityEnum, any>>;
} & {} & {
    airQuality$Changed: ClusterEvents.AttributeObservable<Attribute<AirQuality.AirQualityEnum, any>>;
} & {} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{
    extremelyPoor: BitFlag;
    fair: BitFlag;
    moderate: BitFlag;
    veryPoor: BitFlag;
}>

Supported features as a flag object.

Type declaration

  • ReadonlyextremelyPoor: BitFlag

    ExtremelyPoor

    Cluster supports the Extremely poor air quality level

  • Readonlyfair: BitFlag

    Fair

    Cluster supports the Fair air quality level

  • Readonlymoderate: BitFlag

    Moderate

    Cluster supports the Moderate air quality level

  • ReadonlyveryPoor: BitFlag

    VeryPoor

    Cluster supports the Very poor air quality level

session

session: SecureSession

Readonlystate

state: Omit<{}, never> & {
    airQuality: AirQuality.AirQualityEnum;
} & {} & {} & {}

Access the behavior's state.

Type declaration

  • ReadonlyairQuality: AirQuality.AirQualityEnum

    Indicates a value from AirQualityEnum that is indicative of the currently measured air quality.

    See

    MatterSpecification.v13.Cluster § 2.9.6.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