Class GroupsServer

This is the default server implementation of GroupsBehavior.

Hierarchy (view full)

Constructors

constructor

Properties

[reference] agent cluster context endpoint env events features session state cluster defaults dependencies? early Events ExtensionInterface id Interface Internal name schema? State supervisor supports

Methods

[asyncDispose] addGroup addGroupIfIdentifying asAdmin assertAttributeEnabled callback getGroupMembership initialize reactTo removeAllGroups removeGroup requireAttributeEnabled toString viewGroup alter enable for set with

Constructors

constructor

  • new GroupsServer(agent, backing): GroupsServer

  • Parameters

    • agent: Agent
    • backing: BehaviorBacking

    Returns GroupsServer

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<ClusterEvents<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    nameSupport$Changing: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromPartialBitSchema<{
        nameSupport: BitFlag;
    }>, any>>;
} & {} & {
    nameSupport$Changed: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromPartialBitSchema<{
        nameSupport: BitFlag;
    }>, any>>;
} & {} & {} & {}

Access the behavior's events.

features

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

Supported features as a flag object.

session

session: SecureSession

Readonlystate

state: Omit<ClusterState.Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {} & {} & {
    nameSupport: TypeFromPartialBitSchema<{
        nameSupport: BitFlag;
    }>;
} & {}

Access the behavior's state.

Type declaration

  • ReadonlynameSupport: TypeFromPartialBitSchema<{
        nameSupport: BitFlag;
    }>

    This attribute provides legacy, read-only access to whether the Group Names feature is supported. The most significant bit, bit 7 (GroupNames), shall be equal to bit 0 of the FeatureMap attribute (GN Feature). All other bits shall be 0.

    See

    MatterSpecification.v13.Cluster § 1.3.6.1

Static Readonlycluster

cluster: Groups.Cluster

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

Static Readonlydefaults

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

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

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

Static ReadonlyExtensionInterface

ExtensionInterface: {}

Static Readonlyid

id

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

Static ReadonlyInterface

Interface: GroupsInterface

Static ReadonlyInternal

Internal: (new () => {})

Type declaration

    • new (): {}

    • Implementation of internal state. Subclasses may override to extend.

      Returns {}

    Static Readonlyname

    name: string

    Static Optional Readonlyschema

    schema?: Schema

    Static ReadonlyState

    State: (new () => ClusterState.Type<Groups.Cluster, Type<Of<{
        attributes: {};
        commands: {};
        events: {};
        id: 0;
        name: "Unknown";
        revision: 0;
    }>, typeof ClusterBehavior, GroupsInterface>>)

    Static Readonlysupervisor

    supervisor: RootSupervisor

    Staticsupports

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

    Type declaration

      • (other): boolean

      • Does this behavior support functionality of a specific implementation?

        Parameters

        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

    addGroup

    addGroupIfIdentifying

    • addGroupIfIdentifying(request): MaybePromise

    • The AddGroupIfIdentifying command allows a client to add group membership in a particular group for the server endpoint, on condition that the endpoint is identifying itself. Identifying functionality is controlled using the Identify cluster, (see Identify Cluster).

      For correct operation of the AddGroupIfIdentifying command, any endpoint that supports the Groups server cluster shall also support the Identify server cluster.

      This command might be used to assist configuring group membership in the absence of a commissioning tool.

      Parameters

      Returns MaybePromise

      See

      MatterSpecification.v13.Cluster § 1.3.7.6

    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

    assertAttributeEnabled

    • assertAttributeEnabled<This, K>(this, attributeName): void

    • Type Parameters

      • This extends Behavior
      • K extends string | number | symbol

      Parameters

      • this: This
      • attributeName: K

      Returns void

    Protectedcallback

    • 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

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

        • (...args): undefined | R

        • Parameters

          • Rest...args: A

          Returns undefined | R

    getGroupMembership

    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

      ProtectedreactTo

      • 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

        Parameters

        Returns void

      removeAllGroups

      • removeAllGroups(): MaybePromise

      • The RemoveAllGroups command allows a client to direct the server to remove all group associations for the server endpoint.

        Returns MaybePromise

        See

        MatterSpecification.v13.Cluster § 1.3.7.5

      removeGroup

      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>

      toString

      • toString(): string

      • Description used in diagnostic messages.

        Returns string

      viewGroup

      Staticalter

      Staticenable

      Staticfor

      Staticset

      • set<This>(this, defaults): This

      • Type Parameters

        Parameters

        Returns This

      Staticwith

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods