Skip to main content

@wildix/xbees-conversations-client > AddChannelMembersInput

AddChannelMembersInput interface

Signature:

export interface AddChannelMembersInput 

Properties

Property

Modifiers

Type

Description

channelId

string

The unique identifier of the channel to which members are to be added.

hideHistory?

boolean | undefined

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

members?

(string)[] | undefined

(Optional) A list of user IDs to be added as members of the channel.

membersToInvite?

(UserToInvite)[] | undefined

(Optional) A list of users to invite to the channel, identified by their email addresses or phone numbers.

silent?

boolean | undefined

(Optional) Set to true to suppress system messages that members were added to the conversation. Default is false.

userId?

string | undefined

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