Interface KickGroupHandleInput

Properties required to kick a handle from a group.

KickGroupHandleInput

interface KickGroupHandleInput {
    groupId: GroupId;
    handleId: HandleId;
    reason?: string;
    targetHandleId: HandleId;
}

Properties

groupId: GroupId

Identifier of the group.

handleId: HandleId

Identifier of the handle owned by this client.

reason?: string

Optional reason associated with the action.

targetHandleId: HandleId

Identifier of the handle associated with the handle you intend to kick.