Class AdministratorCommissioningServer

This is the default server implementation of AdministratorCommissioningBehavior.

This implementation includes all features of AdministratorCommissioning.Cluster. You should use AdministratorCommissioningServer.with to specialize the class for the features your implementation supports.

Hierarchy (view full)

AdministratorCommissioningBehavior
- AdministratorCommissioningServer

Constructors

constructor

new AdministratorCommissioningServer(agent, backing): AdministratorCommissioningServer
Parameters
- agent: Agent
- backing: BehaviorBacking
Returns AdministratorCommissioningServer
Inherited from AdministratorCommissioningBehavior.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<ClusterEvents<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    adminFabricIndex$Changing: ClusterEvents.AttributeObservable<Attribute<null | FabricIndex, any>>;
    adminVendorId$Changing: ClusterEvents.AttributeObservable<Attribute<null | VendorId, any>>;
    windowStatus$Changing: ClusterEvents.AttributeObservable<Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>>;
} & {} & {
    adminFabricIndex$Changed: ClusterEvents.AttributeObservable<Attribute<null | FabricIndex, any>>;
    adminVendorId$Changed: ClusterEvents.AttributeObservable<Attribute<null | VendorId, any>>;
    windowStatus$Changed: ClusterEvents.AttributeObservable<Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>>;
} & {} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
basic: BitFlag;
}>

Supported features as a flag object.

internal

internal: Internal

session

session: SecureSession

state

state: State

Access the behavior's state.

`Static` `Readonly`cluster

cluster: AdministratorCommissioning.Cluster

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

`Static` `Readonly`defaults

defaults: ClusterState.Type<AdministratorCommissioning.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, AdministratorCommissioningInterface>>

`Static` `Optional` `Readonly`dependencies

dependencies?: Iterable<Type, any, any>

`Static` `Readonly`early

early: boolean

`Static` `Readonly`Events

Events: ClusterEvents.Type<AdministratorCommissioning.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, AdministratorCommissioningInterface>>

`Static` `Readonly`ExtensionInterface

ExtensionInterface: {}

`Static` `Readonly`id

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

`Static` `Readonly`Interface

Interface: AdministratorCommissioningInterface

`Static` `Readonly`name

name: string

`Static` `Optional` `Readonly`schema

schema?: Schema

`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](): void
Clean up resources and stop the timer when the behavior is destroyed.

Returns void
Overrides AdministratorCommissioningBehavior.[asyncDispose]
- Defined in packages/node/dist/esm/behaviors/administrator-commissioning/AdministratorCommissioningServer.d.ts:30

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 AdministratorCommissioningBehavior.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 AdministratorCommissioningBehavior.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 AdministratorCommissioningBehavior.callback
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:132

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
Inherited from AdministratorCommissioningBehavior.initialize
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:110

openBasicCommissioningWindow

openBasicCommissioningWindow(__namedParameters): Promise<void>
This method opens a Basic Commissioning Window. The default passcode is used.
Parameters
- __namedParameters: AdministratorCommissioning.OpenBasicCommissioningWindowRequest
Returns Promise<void>
- Defined in packages/node/dist/esm/behaviors/administrator-commissioning/AdministratorCommissioningServer.d.ts:24

openCommissioningWindow

openCommissioningWindow(__namedParameters): Promise<void>
This method opens an Enhanced Commissioning Window (a dynamic passcode is used which was provided by the caller).
Parameters
- __namedParameters: AdministratorCommissioning.OpenCommissioningWindowRequest
Returns Promise<void>
Overrides AdministratorCommissioningBehavior.openCommissioningWindow
- Defined in packages/node/dist/esm/behaviors/administrator-commissioning/AdministratorCommissioningServer.d.ts:22

`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 AdministratorCommissioningBehavior.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 AdministratorCommissioningBehavior.requireAttributeEnabled
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:111

revokeCommissioning

revokeCommissioning(): Promise<void>
This method is used to revoke a commissioning window.

Returns Promise<void>
Overrides AdministratorCommissioningBehavior.revokeCommissioning
- Defined in packages/node/dist/esm/behaviors/administrator-commissioning/AdministratorCommissioningServer.d.ts:26

toString

toString(): string
Description used in diagnostic messages.

Returns string
Inherited from AdministratorCommissioningBehavior.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 AdministratorCommissioningBehavior.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 AdministratorCommissioningBehavior.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 AdministratorCommissioningBehavior.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 AdministratorCommissioningBehavior.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 AdministratorCommissioningBehavior.with
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:141

Class AdministratorCommissioningServer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AdministratorCommissioningServer

Properties

[reference]

agent

cluster

context

endpoint

env

Readonlyevents

features

internal

session

state

Static Readonlycluster

Static Readonlydefaults

Static Optional Readonlydependencies

Static Readonlyearly

Static ReadonlyEvents

Static ReadonlyExtensionInterface

Static Readonlyid

Static ReadonlyInterface

Static Readonlyname

Static Optional Readonlyschema

Static Readonlysupervisor

Staticsupports

Type declaration

Parameters

Returns boolean

Methods

[asyncDispose]

Returns void

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

Parameters

Returns MaybePromise

openBasicCommissioningWindow

Parameters

Returns Promise<void>

openCommissioningWindow

Parameters

Returns Promise<void>

ProtectedreactTo

Type Parameters

Parameters

Returns void

requireAttributeEnabled

Type Parameters

Parameters

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

revokeCommissioning

Returns Promise<void>

toString

Returns string

Staticalter

Type Parameters

Parameters

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

Staticenable

`Readonly`events

`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`name

`Static` `Optional` `Readonly`schema

`Static` `Readonly`supervisor

`Static`supports

`Protected`callback

`Protected`reactTo

`Static`alter

`Static`enable

`Static`for

`Static`set

`Static`with