Interface LaundryDryerControlsBehavior

interface LaundryDryerControlsBehavior {
    [reference]: Datasource<StateType>;
    agent: Agent;
    cluster: never;
    context: ActionContext;
    endpoint: Endpoint<Empty>;
    env: Environment;
    events: EventEmitter & Omit<Events, never> & {
        selectedDrynessLevel$Changing: ClusterEvents.AttributeObservable<WritableAttribute<null | LaundryDryerControls.DrynessLevel, any>>;
        supportedDrynessLevels$Changing: ClusterEvents.AttributeObservable<WritableAttribute<LaundryDryerControls.DrynessLevel[], any>>;
    } & {} & {
        selectedDrynessLevel$Changed: ClusterEvents.AttributeObservable<WritableAttribute<null | LaundryDryerControls.DrynessLevel, any>>;
        supportedDrynessLevels$Changed: ClusterEvents.AttributeObservable<WritableAttribute<LaundryDryerControls.DrynessLevel[], any>>;
    } & {} & {} & {};
    features: TypeFromBitSchema<{}>;
    session: SecureSession;
    state: Omit<{}, never> & {
        selectedDrynessLevel: null | LaundryDryerControls.DrynessLevel;
        supportedDrynessLevels: LaundryDryerControls.DrynessLevel[];
    } & {} & {} & {};
    [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> & {
    selectedDrynessLevel$Changing: ClusterEvents.AttributeObservable<WritableAttribute<null | LaundryDryerControls.DrynessLevel, any>>;
    supportedDrynessLevels$Changing: ClusterEvents.AttributeObservable<WritableAttribute<LaundryDryerControls.DrynessLevel[], any>>;
} & {} & {
    selectedDrynessLevel$Changed: ClusterEvents.AttributeObservable<WritableAttribute<null | LaundryDryerControls.DrynessLevel, any>>;
    supportedDrynessLevels$Changed: ClusterEvents.AttributeObservable<WritableAttribute<LaundryDryerControls.DrynessLevel[], any>>;
} & {} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{}>

Supported features as a flag object.

session

session: SecureSession

Readonlystate

state: Omit<{}, never> & {
    selectedDrynessLevel: null | LaundryDryerControls.DrynessLevel;
    supportedDrynessLevels: LaundryDryerControls.DrynessLevel[];
} & {} & {} & {}

Access the behavior's state.

Type declaration

  • ReadonlyselectedDrynessLevel: null | LaundryDryerControls.DrynessLevel

    Indicates the currently-selected dryness level and it shall be the index into the SupportedDrynessLevels list of the selected dryness level.

    If an attempt is made to write this attribute with a value other than null or a value contained in SupportedDrynessLevels, a CONSTRAINT_ERROR response shall be sent as the response. If an attempt is made to write this attribute while the device is not in a state that supports modifying the dryness level, an INVALID_IN_STATE error shall be sent as the response. A value of null shall indicate that there will be no dryness level setting for the current mode.

    See

    MatterSpecification.v13.Cluster § 8.9.5.2

  • ReadonlysupportedDrynessLevels: LaundryDryerControls.DrynessLevel[]

    Indicates the list of supported dryness levels available to the appliance in the

    currently selected mode. The dryness level values are determined by the manufacturer. At least one dryness level value shall be provided in the SupportedDrynessLevels list. The list of dryness levels may change depending on the currently-selected Laundry Dryer mode.

    See

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