Interface GroupsBehavior

interface GroupsBehavior {
    [reference]: Datasource<StateType>;
    agent: Agent;
    cluster: never;
    context: ActionContext;
    endpoint: Endpoint<Empty>;
    env: Environment;
    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>>;
    } & {} & {} & {};
    features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
        groupNames: BitFlag;
    }>;
    session: SecureSession;
    state: Omit<ClusterState.Type<Of<{
        attributes: {};
        commands: {};
        events: {};
        id: 0;
        name: "Unknown";
        revision: 0;
    }>, typeof ClusterBehavior>, never> & {} & {} & {
        nameSupport: TypeFromPartialBitSchema<{
            nameSupport: BitFlag;
        }>;
    } & {};
    [asyncDispose](): MaybePromise;
    addGroup(request: Groups.AddGroupRequest): MaybePromise<Groups.AddGroupResponse>;
    addGroupIfIdentifying(request: Groups.AddGroupIfIdentifyingRequest): MaybePromise;
    asAdmin(fn: (() => void)): void;
    assertAttributeEnabled<This, K>(this: This, attributeName: K): void;
    callback<A, R>(reactor: Reactor<A, R>, options?: Reactor.Options): ((...args: A) => undefined | R);
    getGroupMembership(request: Groups.GetGroupMembershipRequest): MaybePromise<Groups.GetGroupMembershipResponse>;
    initialize(_options?: {}): MaybePromise;
    reactTo<O>(observable: O, reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>, options?: Reactor.Options): void;
    removeAllGroups(): MaybePromise;
    removeGroup(request: Groups.RemoveGroupRequest): MaybePromise<Groups.RemoveGroupResponse>;
    requireAttributeEnabled<This, K>(this: This, attributeName: K): Exclude<This["state"][K], undefined>;
    toString(): string;
    viewGroup(request: Groups.ViewGroupRequest): MaybePromise<Groups.ViewGroupResponse>;
    State: any;
}

Hierarchy (view full)

Properties

[reference] agent cluster context endpoint env events features session state

Methods

[asyncDispose] addGroup addGroupIfIdentifying asAdmin assertAttributeEnabled callback getGroupMembership initialize reactTo removeAllGroups removeGroup requireAttributeEnabled toString viewGroup

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

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

    • viewGroup(request): MaybePromise<Groups.ViewGroupResponse>

    • The ViewGroup command allows a client to request that the server responds with a ViewGroupResponse command containing the name string for a particular group.

      Parameters

      Returns MaybePromise<Groups.ViewGroupResponse>

      See

      MatterSpecification.v13.Cluster § 1.3.7.2

    Settings

    Member Visibility

    On This Page

    Properties
    Methods