For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
ReferenceGuidesClick-to-Call
ReferenceGuidesClick-to-Call
  • Core
    • Overview
  • SignalWire Client
    • Overview
    • Notifications
    • Client
    • Utility functions
  • Video
    • Overview
    • LocalOverlay
    • RoomSession
    • RoomSessionDevice
    • RoomSessionPlayback
    • RoomSessionRecording
    • RoomSessionScreenShare
    • RoomSessionStream
    • RoomDevice
    • RoomScreenShare
  • Chat
    • Overview
    • Client
      • Events
        • disconnect
        • getAllowedChannels
        • getMembers
        • getMemberState
        • getMessages
        • off
        • on
        • once
        • publish
        • removeAllListeners
        • setMemberState
        • subscribe
        • unsubscribe
        • updateToken
    • ChatMember
    • ChatMemberEntity
    • ChatMessage
    • ChatMessageEntity
  • PubSub
    • Overview
    • Client
    • PubSubMessage
  • WebRTC
    • Overview
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Returns
  • Examples
ChatClientMethods

getAllowedChannels

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

getMembers

Next
Built with
  • getAllowedChannels(): Promise<Object>

Returns the channels that the current token allows you to subscribe to.

Returns

Promise<Object>

An object whose keys are the channel names, and whose values are the permissions. For example:

1{
2 "my-channel-1": { "read": true, "write": false },
3 "my-channel-2": { "read": true, "write": true },
4}

Examples

1const chatClient = new Chat.Client({
2 token: "<your chat token>",
3});
4
5const channels = await chatClient.getAllowedChannels();
6console.log(channels);