Interface HepaFilterMonitoringBehavior

interface HepaFilterMonitoringBehavior {
    [reference]: Datasource<StateType>;
    agent: Agent;
    cluster: never;
    context: ActionContext;
    endpoint: Endpoint<Empty>;
    env: Environment;
    events: EventEmitter & Omit<ClusterEvents<Of<{
        attributes: {};
        commands: {};
        events: {};
        id: 0;
        name: "Unknown";
        revision: 0;
    }>, typeof ClusterBehavior>, never> & {
        changeIndication$Changing: ClusterEvents.AttributeObservable<Attribute<ResourceMonitoring.ChangeIndication, any>>;
    } & {
        inPlaceIndicator$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<boolean, any>>;
        lastChangedTime$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<null | number, any>>;
    } & {
        changeIndication$Changed: ClusterEvents.AttributeObservable<Attribute<ResourceMonitoring.ChangeIndication, any>>;
    } & {
        inPlaceIndicator$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<boolean, any>>;
        lastChangedTime$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<null | number, any>>;
    } & {} & {};
    features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
        condition: BitFlag;
        replacementProductList: BitFlag;
        warning: BitFlag;
    }>;
    session: SecureSession;
    state: Omit<ClusterState.Type<Of<{
        attributes: {};
        commands: {};
        events: {};
        id: 0;
        name: "Unknown";
        revision: 0;
    }>, typeof ClusterBehavior>, never> & {
        changeIndication: ResourceMonitoring.ChangeIndication;
    } & {
        inPlaceIndicator?: boolean;
        lastChangedTime?: null | number;
    } & {} & {};
    [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>;
    resetCondition(): MaybePromise;
    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 resetCondition 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<ClusterEvents<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    changeIndication$Changing: ClusterEvents.AttributeObservable<Attribute<ResourceMonitoring.ChangeIndication, any>>;
} & {
    inPlaceIndicator$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<boolean, any>>;
    lastChangedTime$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<null | number, any>>;
} & {
    changeIndication$Changed: ClusterEvents.AttributeObservable<Attribute<ResourceMonitoring.ChangeIndication, any>>;
} & {
    inPlaceIndicator$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<boolean, any>>;
    lastChangedTime$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<null | number, any>>;
} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
    condition: BitFlag;
    replacementProductList: BitFlag;
    warning: BitFlag;
}>

Supported features as a flag object.

session

session: SecureSession

Readonlystate

state: Omit<ClusterState.Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    changeIndication: ResourceMonitoring.ChangeIndication;
} & {
    inPlaceIndicator?: boolean;
    lastChangedTime?: null | number;
} & {} & {}

Access the behavior's state.

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

    resetCondition

    • resetCondition(): MaybePromise

    • Upon receipt, the device shall reset the Condition and ChangeIndicator attributes, indicating full resource availability and readiness for use, as initially configured. Invocation of this command may cause the LastChangedTime to be updated automatically based on the clock of the server, if the server supports setting the attribute.

      Returns MaybePromise

      See

      MatterSpecification.v13.Cluster § 2.8.7.1

    toString

    Settings

    Member Visibility

    On This Page

    Properties
    Methods