Interface Base

interface Base {
    addGroup(request: Groups.AddGroupRequest): MaybePromise<Groups.AddGroupResponse>;
    addGroupIfIdentifying(request: Groups.AddGroupIfIdentifyingRequest): MaybePromise;
    getGroupMembership(request: Groups.GetGroupMembershipRequest): MaybePromise<Groups.GetGroupMembershipResponse>;
    removeAllGroups(): MaybePromise;
    removeGroup(request: Groups.RemoveGroupRequest): MaybePromise<Groups.RemoveGroupResponse>;
    viewGroup(request: Groups.ViewGroupRequest): MaybePromise<Groups.ViewGroupResponse>;
}

Index

Methods

addGroup addGroupIfIdentifying getGroupMembership removeAllGroups removeGroup viewGroup

Methods

addGroup

addGroup(request): MaybePromise<Groups.AddGroupResponse>
The AddGroup command allows a client to add group membership in a particular group for the server endpoint.
Parameters
- request: Groups.AddGroupRequest
Returns MaybePromise<Groups.AddGroupResponse>
See
MatterSpecification.v13.Cluster § 1.3.7.1
- Defined in packages/node/src/behaviors/groups/GroupsInterface.ts:19

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
- request: Groups.AddGroupIfIdentifyingRequest
Returns MaybePromise
See
MatterSpecification.v13.Cluster § 1.3.7.6
- Defined in packages/node/src/behaviors/groups/GroupsInterface.ts:65

getGroupMembership

getGroupMembership(request): MaybePromise<Groups.GetGroupMembershipResponse>
The GetGroupMembership command allows a client to inquire about the group membership of the server endpoint, in a number of ways.
Parameters
- request: Groups.GetGroupMembershipRequest
Returns MaybePromise<Groups.GetGroupMembershipResponse>
See
MatterSpecification.v13.Cluster § 1.3.7.3
- Defined in packages/node/src/behaviors/groups/GroupsInterface.ts:35

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
- Defined in packages/node/src/behaviors/groups/GroupsInterface.ts:51

removeGroup

removeGroup(request): MaybePromise<Groups.RemoveGroupResponse>
The RemoveGroup command allows a client to request that the server removes the membership for the server endpoint, if any, in a particular group.
Parameters
- request: Groups.RemoveGroupRequest
Returns MaybePromise<Groups.RemoveGroupResponse>
See
MatterSpecification.v13.Cluster § 1.3.7.4
- Defined in packages/node/src/behaviors/groups/GroupsInterface.ts:43

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
- request: Groups.ViewGroupRequest
Returns MaybePromise<Groups.ViewGroupResponse>
See
MatterSpecification.v13.Cluster § 1.3.7.2
- Defined in packages/node/src/behaviors/groups/GroupsInterface.ts:27