Channel object

The Channel object represents a single chat room where users can send and receive messages.

Properties

The Channel object has the following properties:

Parameter	Description
Id Type: FString	Unique identifier for the channel. Verify the channel ID with our validator. Access using GetChannelID().
ChannelData Type: FPubnubChatChannelData	Additional data. Access using GetChannelData().
→ ChannelName Type: FString	Display name for the channel (must not be empty or consist only of whitespace characters).
→ Description Type: FString	Brief description or summary of the channel's purpose or content.
→ Custom Type: FString	JSON providing custom data about the channel. Values must be scalar only; arrays or objects are not supported. Filtering App Context data through the custom property is not recommended in SDKs.
→ Status Type: FString	Tag that lets you categorize your app channels by their current state. The tag choice is entirely up to you and depends on your use case. Maximum length is 50 characters.
→ Type Type: FString	Tag that lets you categorize your app channels by their functional roles. The tag choice is entirely up to you and depends on your use case. Maximum length is 50 characters.

API limits

To learn about the maximum length of parameters used to set channel metadata, refer to REST API docs.

Methods

You can call the following methods on the Channel object.

Click on each method for more details.

• Connect()
• CreateMessageDraft()
• Delete()
• Disconnect()
• EmitCustomEvent()
• EmitUserMention()
• FetchReadReceipts()
• ForwardMessage()
• GetChannelData()
• GetChannelID()
• GetHistory()
• GetInvitees()
• GetMember()
• GetMembers()
• GetMessage()
• GetMessageReportsHistory()
• GetPinnedMessage()
• GetUserRestrictions()
• GetUsersRestrictions()
• HasMember()
• Invite()
• InviteMultiple()
• IsPresent()
• Join()
• Leave()
• PinMessage()
• SendText()
• SetRestrictions()
• StartTyping()
• StopTyping()
• UnpinMessage()
• Update()
• WhoIsPresent()

Streaming

Call these methods to subscribe to or unsubscribe from real-time events on this Channel object.

• StreamCustomEvents()
• StopStreamingCustomEvents()
• StreamMessageReports()
• StopStreamingMessageReports()
• StreamPresence()
• StopStreamingPresence()
• StreamReadReceipts()
• StopStreamingReadReceipts()
• StreamTyping()
• StopStreamingTyping()
• StreamUpdates()
• StopStreamingUpdates()
• StreamUpdatesOn()

Use case

Use the Channel object methods to:

• Let users send messages.
• Create and manage a 1:1, group, or public channel (chat).
• Invite others to join the channel.
• Configure a typing indicator to track when someone in the room is writing a message.