Channel entity
Channel
is an object that refers to a single chat room.
Properties
The Channel
interface takes the following properties:
interface Channel {
val chat: Chat
val id: String
val name: String?
val custom: Map<String, Any?>?
val description: String?
val updated: String?
val status: String?
val type: ChannelType?
...
}
Parameter | Description |
---|---|
chat Type: Chat | Reference to the main Chat object. |
id Type: String | Unique identifier for the channel. Verify the channel ID with our validator. |
name Type: String | Display name or title of the channel. |
custom Type: Map<String, Any?> | Any custom properties or metadata associated with the channel in the form of a map of key-value pairs. App Context filtering language doesn’t support filtering by custom properties. |
description Type: String | Brief description or summary of the channel's purpose or content. |
updated Type: String | Timestamp for the last time the channel was updated or modified. |
status Type: String | Current status of the channel, like online , offline , or archived . |
type Type: ChannelType | One of the available channel types:
|
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()
deleteFile()
forwardMessage()
getFiles()
getHistory()
getMessage()
getMessageReportsHistory()
getMembers()
getPinnedMessage()
getTyping()
getUserRestrictions()
getUsersRestrictions()
invite()
inviteMultiple()
isPresent()
join()
leave()
pinMessage()
registerForPush()
sendText()
setRestrictions()
startTyping()
stopTyping()
streamPresence()
streamReadReceipts()
streamMessageReports
streamUpdates()
streamUpdatesOn()
update()
unpinMessage()
unregisterFromPush()
whoIsPresent()
Use case
For example, you can use the Channel
-related methods to:
- 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.
- Register the channel for mobile push notifications, not to miss a single message.