Class BooleanStateServer

This is the default server implementation of BooleanStateBehavior. If the StateChanged event is enabled it is emitted automatically on state change.

Hierarchy (view full)

Constructors

constructor

Properties

[reference] agent cluster context endpoint env events features session state cluster defaults dependencies? early Events ExtensionInterface id Interface Internal name schema? State supervisor supports

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize reactTo requireAttributeEnabled toString alter enable for set with

Constructors

constructor

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

Static Readonlycluster

cluster: BooleanState.Cluster

Base cluster state include all attribute values but may be extended by subclasses.

Static Readonlydefaults

defaults: ClusterState.Type<BooleanState.Cluster, typeof ClusterBehavior>

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

Events: ClusterEvents.Type<BooleanState.Cluster, typeof ClusterBehavior>

Static ReadonlyExtensionInterface

ExtensionInterface: {}

Static Readonlyid

id

The behavior ID for ClusterBehaviors is the name of the cluster.

Static ReadonlyInterface

Interface: {
    components: never[];
}

Static ReadonlyInternal

Internal: (new () => {})

Static Readonlyname

name: string

Static Optional Readonlyschema

schema?: Schema

Static ReadonlyState

State: (new () => ClusterState.Type<BooleanState.Cluster, typeof ClusterBehavior>)

Static Readonlysupervisor

supervisor: RootSupervisor

Staticsupports

supports: ((other: Type) => boolean)

Type declaration

    • (other): boolean

    • Does this behavior support functionality of a specific implementation?

      Parameters

      Returns boolean

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

ProtectedreactTo

requireAttributeEnabled

toString

Staticalter

Staticenable

Staticfor

Staticset

Staticwith

Settings

Member Visibility

On This Page

Constructors
Properties
Methods