Skip to main content

@wildix/xbees-conversations-client > UpdateChannelInput

UpdateChannelInput interface

Signature:

export interface UpdateChannelInput 

Properties

Property

Modifiers

Type

Description

access?

ChannelAccess

(Optional) The access level of the channel.

broadcast?

boolean

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

channelId

string

The unique identifier of the channel to be updated.

description?

string

(Optional) The description of the channel.

picture?

string

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

pictureColor?

string

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

silent?

boolean

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

subject?

string

(Optional) The subject of the channel.

userId?

string

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