Create new endpoint.
The endpoint will not initialize fully until added to a Node. You can use Endpoint.add to construct and initialize an Endpoint in one step.
Create new endpoint.
The endpoint will not initialize fully until added to a Node. You can use Endpoint.add to construct and initialize an Endpoint in one step.
Optionaloptions: Options<T, EndpointOptions>Hierarchical diagnostics of endpoint and children.
Create an Agent.Type for the endpoint.
ProtectedcontainerDiagnostic information regarding endpoint state.
The endpoint's environment. Endpoint implementations use the environment to access platform components such as storage and network components.
Is this a parent Endpoint?
A string that uniquely identifies an endpoint.
This ID must be unique amongst all Parts with the same owner.
Endpoint information that varies as the endpoint initializes.
The endpoint ID or undefined if not yet assigned.
The endpoint number or undefined if not yet assigned.
The Matter EndpointNumber of the endpoint. This uniquely identifies the Endpoint in the scope of the Matter node.
Path identifying the endpoint in the Matter data model.
The type of endpoint this endpoint implements.
Complete initialization. Invoked via Construction#start by the owner.
Execute a function against an Agent for the endpoint.
Agents provide the highest-leve API for interacting with endpoints. The agent is a composite object with properties for each supported behavior.
State changes made by actor are atomic and made permanent only when the actor exits unless you commit the transaction manually.
actor runs in an "offline" context where ACLs are ignored and all state is read/write.
The Agent is destroyed after actor exits so you should not maintain references to the agent, its behaviors or associated state.
actor may be async. If so, the acting context will remain open until the returned Promise resolves.
textual description of operation used for diagnostics
the function that performs the action
Version of act without explicit diagnostic purpose.
Add a child endpoint. If this endpoint is initialized, awaits child initialization.
If child initialization fails:
If the child is essential (@see EndpointLifecycle#isEssential), removes the child and rethrows
If the child is non-essential then logs the error but leaves the child installed.
the Endpoint or Endpoint.Configuration
Add a child endpoint with separate type and options arguments.
the EndpointType of the child endpoint
Optionaloptions: Options<T, EndpointOptions>settings for the new endpoint
ProtectedassertProtectedcreateOptionalisEssential: booleanProtectedinitializeAsynchronous initialization.
Derivatives may override to perform async construction prior to full initialization.
Update state values. This is a patch operation; it only modifies properties in values.
values is an object with a Behavior.id as the key and state values as sub-objects.
Input values must adhere to the Behavior.schema of the target Behavior. If not, set will throw an error.
This is a transactional operation. An error results in no change. The endpoint will wait for exclusive access before applying changes.
the values to change
Endpoints consist of a hierarchy of parts. This class manages the current state of a single endpoint.
You can interact with endpoints using an Agent created with Endpoint.agentFor. Agents are stateless and designed for quick instantiation so you can create them as needed then discard.
Most often direct access to Agent is transparent as Matter.js acquires an agent as necessary for Behavior interactions.