getChannel( )

Gets a chatbox channel.

The getChannel() function returns a Promise that resolves to the requested channel. You can get a channel by specifying one of the following:

  • Channel ID: Gets the channel with the specified ID. type is ignored.

  • Type: Gets the channel of the specified type:

    • "Focused": Gets the currently focused channel.
    • "Business": Gets the business channel.
Method Declaration
Copy
Method Parameters
channelInfoChannelInfoRequired

Channel information specifying which channel to get.

Returns
Return Type:Promise<Channel>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?