Interface ActionContext

Provides contextual information for Matter actions such as accessing attributes or invoking commands.

Matter.js provides an "online" ActionContext for you when responding to network requests. You can also use "offline" agents to invoke cluster APIs Endpoint without an active user session.

See OnlineContext and OfflineContext for details of these two types of interaction.

Context includes:

  • Authorization details such as AccessLevel, subject and accessing fabric

  • The transaction required to make state changes

  • Factory functions for Agent instances you can use to interact with Endpoints

  • When responding to network requests, low-level contextual information such as the wire message

For the formal definition of an "action" see MatterSpecification.v12.Core § 8.2.4

interface ActionContext {
    acceptInvalid?: boolean;
    activity?: Activity;
    command?: boolean;
    exchange?: MessageExchange;
    fabric?: FabricIndex;
    fabricFiltered?: boolean;
    interactionComplete?: AsyncObservable<[], void>;
    message?: Message;
    offline?: boolean;
    session?: SecureSession;
    subject?: NodeId;
    timed?: boolean;
    trace?: Action;
    transaction: Transaction;
    agentFor<const T>(endpoint: Endpoint<T>): Instance<T>;
    authorizedFor(desiredAccessLevel: AccessLevel, location?: Location): boolean;
}

Hierarchy (view full)

Properties

acceptInvalid? activity? command? exchange? fabric? fabricFiltered? interactionComplete? message? offline? session? subject? timed? trace? transaction

Methods

agentFor authorizedFor

Properties

OptionalacceptInvalid

acceptInvalid?: boolean

If this is true, data validation is disabled. This should only be used in contexts where data validation is deferred.

Optionalactivity

activity?: Activity

Activity tracking information. If present, activity frames are inserted at key points for diagnostic purposes.

Optional Readonlycommand

command?: boolean

If this is true then data access levels are not enforced. Datatypes and command-related access controls are active.

Optionalexchange

exchange?: MessageExchange

The Matter exchange in which an interaction occurs.

Optional Readonlyfabric

fabric?: FabricIndex

The fabric of the authorized client.

Optional ReadonlyfabricFiltered

fabricFiltered?: boolean

If this is true, fabric-scoped lists are filtered to the accessing fabric.

OptionalinteractionComplete

interactionComplete?: AsyncObservable<[], void>

If present the session is associated with an online interaction. Emits when the interaction ends.

Optionalmessage

message?: Message

The wire message that initiated invocation.

Optionaloffline

offline?: boolean

If this is true then access levels are not enforced and all values are read/write. Datatypes are still enforced.

Tracks "offline" rather than "online" because this makes the safer mode (full enforcement) the default.

Optionalsession

session?: SecureSession

The Matter session in which an interaction occurs.

Optional Readonlysubject

subject?: NodeId

The authenticated SubjectId for online sessions.

Optional Readonlytimed

timed?: boolean

If this is true a timed transaction is in effect.

Optionaltrace

trace?: Action

A target for instrumentation information. If present, various components will populate with diagnostic information during the action.

transaction

transaction: Transaction

The transaction used for isolating state changes associated with this session.

Methods

agentFor

  • agentFor<const T>(endpoint): Instance<T>

  • Obtain an agent for interacting with an endpoint in this context.

    Type Parameters

    Parameters

    Returns Instance<T>

authorizedFor

  • authorizedFor(desiredAccessLevel, location?): boolean

  • Checks if the authorized client has a certain Access Privilege granted.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods