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>;
}

Methods

addGroup addGroupIfIdentifying getGroupMembership removeAllGroups removeGroup viewGroup

Methods

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

getGroupMembership

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

viewGroup

Settings

Member Visibility

On This Page

Methods