Skip to main content

@wildix/xbees-conversations-client > AddChannelMemberInput

AddChannelMemberInput interface

Signature:

export interface AddChannelMemberInput 

Properties

Property

Modifiers

Type

Description

channelId

string

The unique identifier of the channel to which the member is to be added.

hideHistory?

boolean | undefined

(Optional) Set to true to hide the history of the channel for added member. Default is false.

memberId?

string | undefined

(Optional) A User ID of the member to be added to the channel.

memberToInvite?

UserToInvite | undefined

(Optional) A user to invite to the channel, identified by email address or phone number if the member does not already exist.

silent?

boolean | undefined

(Optional) True to not send a system message that members added from the conversartion. Default - false.

userId?

string | undefined

(Optional) The unique identifier of the user when a service token is used.