ThreadChannel object

ThreadChannel is an object that refers to a single thread (channel) in a chat.

Properties

The ThreadChannelImpl class extends ChannelImpl and implements the ThreadChannel protocol. It takes the following properties:

extension ThreadChannelImpl: ThreadChannel {
    public var chat: ChatImpl
    public var id: String
    public var name: String?
    public var custom: [String: JSONCodableScalar]?
    public var channelDescription: String?
    public var updated: String?
    public var status: String?
    public var type: ChannelType?
    public var parentMessage: MessageImpl
    public var parentChannelId: String

    ...
}

Parameter	Description
chat Type: ChatImpl	Reference to the main Chat protocol.
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: [String: JSONCodableScalar]	Any custom properties or metadata associated with the channel in the form of a dictionary 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: direct (1:1) group (multiple people, restricted by invitation) public (open chat for a large audience, anyone can join it) unknown for channels created using the Swift SDK instead of Chat SDK, whose type provided in channel metadata is different than the three default Chat SDK types.
parentMessage Type: MessageImpl	Message for which the thread was created.
parentChannelId Type: String	Unique identifier of the main channel on which you create a subchannel (thread channel) and thread messages.

Methods

You can call the following methods on the ThreadChannel object.

Click on each method for more details.

• getHistory()
• pinMessage()
• pinMessageToParentChannel()
• streamUpdatesOn()
• unpinMessage()
• unpinMessageFromParentChannel()
• All methods available under the ChannelImpl object.

Use case

For example, you can use the ThreadChannel-related methods to:

• Let users create and reply in threads.
• Pin important information when needed.