Skip to main content

@wildix/xbees-conversations-client > UpdateChannelInput

UpdateChannelInput interface

Signature:

export interface UpdateChannelInput 

Properties

Property

Modifiers

Type

Description

access?

ChannelAccess | undefined

(Optional) The access level of the channel.

broadcast?

boolean | undefined

(Optional) Indicates if the channel is broadcast-only. Default is false.

channelId

string

The unique identifier of the channel to be updated.

context?

ChannelContext | undefined

(Optional) An additional information that associated with this channel.

description?

string | undefined

(Optional) The description of the channel.

picture?

string | undefined

(Optional) The URL of the channel's picture.

pictureColor?

string | undefined

(Optional) The dominant color of the channel's picture, represented by a hex value.

silent?

boolean | undefined

(Optional) Set to true to suppress system messages about the updates. Default is false.

subject?

string | undefined

(Optional) The subject of the channel.

userId?

string | undefined

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