Interface KickChannelHandleInput

Properties required to kick a handle from a channel.

KickChannelHandleInput

interface KickChannelHandleInput {
    channelId: ChannelId;
    handleId: HandleId;
    reason?: string;
    targetHandleId: HandleId;
}

Properties

channelId: ChannelId

The identifier of the channel.

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.