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)

BooleanStateBehavior
- BooleanStateServer

Constructors

constructor

new BooleanStateServer(agent, backing): BooleanStateServer
Parameters
- agent: Agent
- backing: BehaviorBacking
Returns BooleanStateServer
Inherited from BooleanStateBehavior.constructor
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:119

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

`Readonly`events

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

Optional ReadonlystateChange?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
stateValue: FieldType<boolean>;
}>, any>>
If this event is supported, it shall be generated when the StateValue attribute changes.

See
MatterSpecification.v13.Cluster § 1.7.5.1

features

features: TypeFromBitSchema<{}>

Supported features as a flag object.

session

session: SecureSession

`Readonly`state

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` `Readonly`cluster

cluster: BooleanState.Cluster

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

`Static` `Readonly`defaults

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

`Static` `Optional` `Readonly`dependencies

dependencies?: Iterable<Type, any, any>

`Static` `Readonly`early

early: boolean

`Static` `Readonly`Events

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

`Static` `Readonly`ExtensionInterface

ExtensionInterface: {}

`Static` `Readonly`id

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

`Static` `Readonly`Interface

Interface: {
components: never[];
}

`Static` `Readonly`Internal

Internal: (new () => {})

Type declaration

- new (): {}
- Implementation of internal state. Subclasses may override to extend.
  
  Returns {}

`Static` `Readonly`name

name: string

`Static` `Optional` `Readonly`schema

schema?: Schema

`Static` `Readonly`State

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

`Static` `Readonly`supervisor

supervisor: RootSupervisor

`Static`supports

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

Type declaration

- (other): boolean
- Does this behavior support functionality of a specific implementation?
  Parameters
  - other: Type
  Returns boolean

Methods

[asyncDispose]

[asyncDispose](): MaybePromise
Release resources. This is the public API for releasing application resources held by behaviors in internal state.

Returns MaybePromise
Inherited from BooleanStateBehavior.[asyncDispose]
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:115

asAdmin

asAdmin(fn): void
Execute logic with elevated privileges.

The provided function executes with privileges escalated to offline mode. This is not commonly necessary.

Elevated logic effectively ignores ACLs so should be used with care.

Note that interactions with the behavior will remain elevated until the synchronous completion of this call. You should only elevate privileges for synchronous logic.
Parameters
- fn: (() => void)
  the elevated logic
  - - (): void
    - Returns void
Returns void
Inherited from BooleanStateBehavior.asAdmin
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:77

assertAttributeEnabled

assertAttributeEnabled<This, K>(this, attributeName): void
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns void
Inherited from BooleanStateBehavior.assertAttributeEnabled
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:112

`Protected`callback

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
- reactor: Reactor<A, R>
- Optionaloptions: Reactor.Options
Returns ((...args: A) => undefined | R)
- - (...args): undefined | R
  - Parameters
    - Rest...args: A
    Returns undefined | R
Inherited from BooleanStateBehavior.callback
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:132

initialize

initialize(): void
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.

Returns void
Overrides BooleanStateBehavior.initialize
- Defined in packages/node/dist/esm/behaviors/boolean-state/BooleanStateServer.d.ts:13

`Protected`reactTo

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
- O extends Observable<any[], any>
Parameters
- observable: O
- reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>
- Optionaloptions: Reactor.Options
Returns void
Inherited from BooleanStateBehavior.reactTo
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:125

requireAttributeEnabled

requireAttributeEnabled<This, K>(this, attributeName): Exclude<This["state"][K], undefined>
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns Exclude<This["state"][K], undefined>
Inherited from BooleanStateBehavior.requireAttributeEnabled
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:111

toString

toString(): string
Description used in diagnostic messages.

Returns string
Inherited from BooleanStateBehavior.toString
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:119

`Static`alter

alter<This, const AlterationsT>(this, alterations): Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const AlterationsT extends Alterations<This["cluster"]>
Parameters
- this: This
- alterations: AlterationsT
Returns Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from BooleanStateBehavior.alter
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:142

`Static`enable

enable<This, const FlagsT>(this, flags): Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FlagsT extends ElementFlags<This["cluster"]>
Parameters
- this: This
- flags: FlagsT
Returns Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Inherited from BooleanStateBehavior.enable
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:144

`Static`for

for<This, const ClusterT>(this, cluster, schema?): Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const ClusterT extends ClusterType
Parameters
- this: This
- cluster: ClusterT
- Optionalschema: Schema
Returns Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Inherited from BooleanStateBehavior.for
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:140

`Static`set

set<This>(this, defaults): This
Type Parameters
- This extends Type
Parameters
- this: This
- defaults: Partial<RelaxTypes<InstanceType<This["State"]>>>
Returns This
Inherited from BooleanStateBehavior.set
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:143

`Static`with

with<This, const FeaturesT>(this, ...features): Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FeaturesT extends FeatureSelection<This["cluster"]>
Parameters
- this: This
- Rest...features: FeaturesT
Returns Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from BooleanStateBehavior.with
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:141

Class BooleanStateServer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BooleanStateServer

Properties

[reference]

agent

cluster

context

endpoint

env

Readonlyevents

Type declaration

Optional ReadonlystateChange?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{ stateValue: FieldType<boolean>; }>, any>>

See

features

session

Readonlystate

Type declaration

ReadonlystateValue: boolean

See

Static Readonlycluster

Static Readonlydefaults

Static Optional Readonlydependencies

Static Readonlyearly

Static ReadonlyEvents

Static ReadonlyExtensionInterface

Static Readonlyid

Static ReadonlyInterface

Static ReadonlyInternal

Type declaration

Returns {}

Static Readonlyname

Static Optional Readonlyschema

Static ReadonlyState

Static Readonlysupervisor

Staticsupports

Type declaration

Parameters

Returns boolean

Methods

[asyncDispose]

Returns MaybePromise

asAdmin

Parameters

Returns void

Returns void

assertAttributeEnabled

Type Parameters

Parameters

Returns void

Protectedcallback

Type Parameters

Parameters

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

Parameters

Returns undefined | R

initialize

Returns void

ProtectedreactTo

Type Parameters

Parameters

Returns void

requireAttributeEnabled

Type Parameters

Parameters

Returns Exclude<This["state"][K], undefined>

toString

Returns string

Staticalter

Type Parameters

Parameters

Returns Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>

Staticenable

`Readonly`events

`Optional` `Readonly`stateChange?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
stateValue: FieldType<boolean>;
}>, any>>

`Readonly`state

`Readonly`stateValue: boolean

`Static` `Readonly`cluster

`Static` `Readonly`defaults

`Static` `Optional` `Readonly`dependencies

`Static` `Readonly`early

`Static` `Readonly`Events

`Static` `Readonly`ExtensionInterface

`Static` `Readonly`id

`Static` `Readonly`Interface

`Static` `Readonly`Internal

`Static` `Readonly`name

`Static` `Optional` `Readonly`schema

`Static` `Readonly`State

`Static` `Readonly`supervisor

`Static`supports

`Protected`callback

`Protected`reactTo

`Static`alter

`Static`enable

`Static`for

`Static`set

`Static`with