Readonly
eventsAccess the behavior's events.
Access the behavior's state.
Static
Optional
dependenciesExplicitly reference other Behaviors as dependencies, ensuring this behavior is destroyed first.
This probably won't be commonly necessary. If it is we can instrument Agent to collect dependencies automatically.
Static
Readonly
earlyBy default behaviors load lazily as they are accessed. You can set this flag to true to force behaviors to load immediately when the endpoint initializes.
Static
EventsImplementation of the events property. Subclasses may override to extend.
Static
Readonly
idEach behavior implementation has an ID that uniquely identifies the type of behavior. An Endpoint may only have one behavior with the specified ID.
Endpoint instances store each behavior in a property with the same name as the behavior's ID.
EndpointBuilder also uses the ID when replacing behaviors using the with() builder method.
Static
InternalImplementation of internal state. Subclasses may override to extend.
Static
Readonly
schemaDefine logical schema. This enables runtime validation, make fields persistent and makes subfields editable.
The context in which the behavior operates.
The endpoint's environment.
The session in which the behavior has been invoked.
Static
defaultsDefault state values.
Static
supervisorThe data supervisor for the behavior. The supervisor controls validation and access to behavior data.
Release resources. This is the public API for releasing application resources held by behaviors in internal state.
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.
the elevated logic
Protected
callbackCreate 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!
Protected
finalizeOverride to implement CASE commissioning yourself.
If you override, matter.js commissions to the point where over PASE is complete. You must then complete commissioning yourself by connecting to the device and invokeint the "CommissioningComplete" command.
Optional
_discoveryData: DiscoveryDataBehaviors 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.
Optional
descriptor?: RemoteDescriptorProtected
reactInstall a Reactor.
Important: The reactor MUST be a real JS function - arrow functions will not work!
Static
setStatic
supportsDoes this behavior support functionality of a specific implementation?
Client functionality related to commissioning.
Updates node state based on commissioning status and commissions new nodes.