Chat iOS v4
Chat iOS
Chat
iOS
Home
/
Chat
/
iOS
This is the new Docs for Chat SDK v4 beta for iOS. To see the previous Docs, click here.

Message threading

Message threading is a feature that allows users to ask questions, give feedback or add context to a specific message without disrupting the conversation flow. A message thread refers to a collection of messages grouped together, consisting of a parent message and its replies. It can have the following elements:

  • A message can have a thread of replies.
  • A message that has a thread of replies is a parent message.
  • A parent message and its threaded replies are collectively called a message thread.
  • Every message within a thread, whether it's parent or reply, is a threaded message.
  • A message that doesn't have any replies is an unthreaded message.


Benefits

Message threading can be widely used to help conversations flow smoothly while keeping users engaged. Message replies in a thread are common among popular messaging platforms, such as Slack and iMessage.

  • Conversation flow: Without message threading, it's hard to specify which message a channel member is responding to. Users would have to explain the context of their response, potentially confusing other channel members and distracting them from reading new messages. Message threads can help everyone stay engaged and carry on their conversation without any interferences.

  • In-depth discussions: By allowing users to reply to each other's messages in a thread, they can have more in-depth conversations on one topic. They're able to ask follow-up questions or provide more detailed explanations to a specific message without interrupting others in the channel. Message threads can encourage users to start topic-specific discussions separate from the main channel conversation.


Limitations

Refer to the following limitations before using the message threading feature:

  • SDK only supports 1-depth threads, meaning you can only add reply messages to non-reply messages. You can't add a reply to a reply message.
  • You can only reply to text and file messages, not admin messages. However, you can add admin type messages as a reply to another message.

List messages along with their replies

You can retrieve messages and their replies.

Load channel messages

The loadNextPage(completionHandler:) method of a PreviousMessageListQuery instance returns a list of BaseMessage objects. With this method, you can retrieve previous messages in a specific channel. To include the replies of the target messages in the results, you need to change the value of the replyType property in the PreviousMessageListQuery instance.

PreviousMessageListQuery

The following table lists the properties of this class.

Property nameTypeDescription

replyType

Type: ReplyType

Determines whether to include replies in the results. .none, .all and .onlyReplyToChannel

includeThreadInfo

Type: bool

Determines whether to include the thread information of the messages in the results when the results contain parent messages.

includeParentMessageInfo

Type: bool

Determines whether to include the parent message object in the results when the retrieved messages are replies in a thread.

limit

Type: UInt

Specifies the number of results to return per call. Acceptable values are 1 to 100, inclusive. The recommended value for this parameter is 30.

reverse

Type: bool

Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.

let listQuery = channel.createPreviousMessageListQuery()!
listQuery.replyType = REPLY_TYPE
listQuery.includeThreadInfo = INCLUDE_THREAD_INFO
listQuery.includeParentMessageInfo = INCLUDE_PARENT_MESSAGE_INFO
listQuery.limit = LIMIT
listQuery.reverse = REVERSE

loadNextPage(completionHandler:)

// Retrieving previous messages.
listQuery.loadNextPage { (messages, error) in
    guard error == nil else {
        // Handle error.
    }
}

Load messages by timestamp or message ID

The getMessages(timestamp:params:completionHandler:) and getMessages(messageId:params:completionHandler:) methods of a BaseChannel instance return a list of BaseMessage objects. By using these methods, you can retrieve messages in a specific channel according to a MessageListParams object.

MessageListParams

The following table lists the properties of this class.

Parameter nameDescription

previousResultSize

Type: Int

Specifies the number of messages to retrieve that were sent before the specified timestamp or message ID.

nextResultSize

Type: Int

Specifies the number of messages to retrieve that were sent after the specified timestamp or message ID.

isInclusive

Type: bool

Determines whether to include the messages with the matching timestamp or message ID in the results.

reverse

Type: bool

Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.

replyType

Type: ReplyType

includeThreadInfo

Type: bool

includeParentMessageInfo

Type: bool

let params = MessageListParams()
params.previousResultSize = PREV_RESULT_SIZE
params.nextResultSize = NEXT_RESULT_SIZE
params.isInclusive = INCLUSIVE
params.reverse = REVERSE
params.replyType = REPLY_TYPE
params.includeThreadInfo = INCLUDE_THREAD_INFO
params.includeParentMessageInfo = INCLUDE_PARENT_MESSAGE_INFO

By timestamp

By using the getMessages(timestamp:params:completionHandler:) method, you can retrieve a set number of messages of previous and next messages on both sides of a specific timestamp in a channel.

channel.getMessages(timestamp: TIMESTAMP, params: params) { (messages, error) in
    guard error == nil else {
        // Handle error.
    }

    // A list of previous and next messages on both sides of a specified timestamp is successfully retrieved.
    // Through the messages parameter of the callback method,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback method.
}

List of parameters

Parameter nameTypeDescription

timestamp

Type: Int64

Specifies the timestamp to be the reference point for messages to retrieve, in Unix milliseconds format. Messages sent before or after the timestamp can be retrieved.

By message ID

By using the getMessages(messageId:params:completionHandler:) method, you can retrieve a set number of previous and next messages on both sides of a specific message ID in a channel.

channel.getMessages(messageId: MESSAGE_ID, params: params) { messages, error in
    guard error == nil else {
        return // Handle error.
    }

    // A list of previous and next messages on both sides of a specified message ID is successfully retrieved.
    // Through the messages parameter of the callback method,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback method.
})

List of parameters

Parameter nameTypeDescription

messageId

Type: Int64

Specifies the message ID to be the reference point for messages to retrieve. Messages sent before or after the message with the matching message ID can be retrieved.


List replies of a parent message

You can retrieve replies of a parent message if you can specify the parent message like the following. First, create an ThreadedMessageListParams object and set properties related to the thread where the target replies belong to.

let params = ThreadedMessageListParams()
params.previousResultSize = PREV_RESULT_SIZE
params.nextResultSize = NEXT_RESULT_SIZE
params.isInclusive = INCLUSIVE
params.reverse = REVERSE
params.includeParentMessageInfo = INCLUDE_PARENT_MESSAGE_INFO

ThreadedMessageListParams

Parameter nameDescription

previousResultSize

Type: NSInteger

Specifies the number of messages to retrieve that were sent before the specified timestamp.

nextResultSize

Type: NSInteger

Specifies the number of messages to retrieve that were sent after the specified timestamp.

isInclusive

Type: bool

Determines whether to include the messages with the matching timestamp in the results.

reverse

Type: bool

Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.

includeParentMessageInfo

Type: bool

Determines whether to include the information of the parent messages in the result.

With the timestamp of the parent message, you can retrieve its replies by passing an ThreadedMessageListParams object as an argument to the parameter in the getThreadedMessages(timestamp:params:completionHandler:) method.

parentMessage.getThreadedMessages(timestamp: TIMESTAMP, params: params) { (parentMessage, threadedReplies, error) in
    guard error == nil else {
        // Handle error.
    }

    // A list of replies of the specified parent message timestamp is successfully retrieved.
    // Through the threadedReplies parameter of the callback method,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback method.
}

List of parameters

Parameter nameTypeDescription

timestamp

lType: Int64

Specifies the timestamp to be the reference point of the retrieval, in Unix milliseconds format.


View a single message

You can retrieve a specific message by creating and passing the MessageRetrievalParams object as a parameter to the getMessage(params:completionHandler:) method.

let params = MessageRetrievalParams()
params.messageId = MESSAGE_ID
params.channelType = CHANNEL_TYPE
params.channelURL = CHANNEL_URL

MessageRetrievalParams

Parameter nameDescription

messageID

Type: Int64

Specifies the unique ID of the message to retrieve.

channelType

Type: ChannelType

Specifies the type of the channel.

channelURL

Type: String

Specifies the URL of the channel to retrieve the message.

BaseMessage.getMessage(params: params) { (message, error) in
    guard error == nil else {
        // Handle error.
    }

    // The specified message is successfully retrieved.
}

Reply to a message

You can reply to a specific message in a channel through the sendUserMessage(params:completionHandler:) or sendFileMessage(params:completionHandler:) method. To do so, you should create a UserMessageCreateParams or a FileMessageCreateParams object and then specify the parentMessageId property of the object. Sending reply messages works the same way as sending regular messages to a channel except replies have an additional parentMessageId property.

Reply with a text message

When replying to a message through the sendUserMessage(params:completionHandler:) method, you should specify and pass a UserMessageCreateParams object to the method as a parameter.

let params = UserMessageCreateParams(message: MESSAGE_TEXT)
params.parentMessageId = PARENT_MESSAGE_ID

UserMessageCreateParams

Parameter nameTypeDescription

parentMessageId

Type: Int64

Specifies the unique ID of a parent message which has a thread of replies. If the message sent through the sendUserMessage(params:completionHandler:) method is a parent message, the value of this property is 0. If the message is a reply to a parent message, the value is the message ID of the parent message.

channel.sendUserMessage(params: params) { (message, error) in
    guard error == nil else {
        // Handle error.
    }

    // A reply to a specific message in the form of a text message is successfully sent.
}

Reply with a file message

When replying with a file message through the sendFileMessage(params:completionHandler:) method, you should specify and pass a FileMessageCreateParams object to the method as a parameter.

let params = FileMessageCreateParams(file: FILE)
params.parentMessageId = PARENT_MESSAGE_ID

FileMessageCreateParams

Parameter nameTypeDescription

parentMessageId

long long

Specifies the unique ID of a parent message which has a thread of replies. If the message sent through the sendFileMessage(params:completionHandler:) method is a parent message, the value of this property is 0. If the message is a reply to a parent message, the value is the message ID of the parent message.

channel.sendFileMessage(params: params) { (message, error) in
    guard error == nil else {
        // Handle error.
    }

    // A reply to a specific message in the form of a file message is successfully sent.
}

List changelogs

You can retrieve message changelogs.

Load message changelogs

Each message changelog has distinct properties such as a timestamp that indicates when a message was updated and a unique ID of a deleted message. Based on these two properties, you can retrieve message changelogs in two different ways: either by timestamp or by token. Both getMessageChangeLogs(token:params:completionHandler: and getMessageChangeLogs(timestamp:params:completionHandler:) methods require a parameter MessageChangeLogsParams object to determine what messages to return.

let params = MessageChangeLogsParams()
params.replyType = REPLY_TYPE
params.includeThreadInfo = INCLUDE_THREAD_INFO
params.includeParentMessageInfo = INCLUDE_PARENT_MESSAGE_INFO

MessageChangeLogsParams

The following table lists the properties of this class.

Parameter nameTypeDescription

replyType

Type: ReplyType

Determines whether to include replies in the results. .none, .all and .onlyReplyToChannel

includeThreadInfo

Type: bool

Determines whether to include the thread information of the messages in the results when the results contain parent messages.

includeParentMessageInfo

Type: bool

Determines whether to include the parent message object in the results when the retrieved messages are replies in a thread.

By timestamp

You can retrieve message changelogs by specifying a timestamp. The results will include changelogs that were created after the specified timestamp.

channel.getMessageChangeLogs(timestamp: TIMESTAMP, params: params) { (updatedMessages, deletedMessageIds, hasMore, token, error) in
    guard error == nil else {
        // Handle error.
    }

    // A list of message changelogs created after the specified timestamp is successfully retrieved.
}

List of parameters

Parameter nameTypeDescription

timestamp

Type: Int64

Specifies the timestamp to be the reference point for changelogs to retrieve, in Unix milliseconds format.

By token

You can also retrieve message changelogs by specifying a token. The token is an opaque string that marks the starting point of the next page in the result set and it is included in the callback of the previous call. Based on the token, the next page will start with changelogs that were created after the specified token.

channel.getMessageChangeLogs(token: TOKEN, params: params) { updatedMessages, deletedMessageIds, hasMore, token, error in
    guard error == nil else {
        return // Handle error.
    }

    // A list of message changelogs created after the specified token is successfully retrieved.
})

Event delegate

Once a reply is created or deleted from a thread, the channel(_:didUpdateThreadInfo:) event delegate method is invoked. The method returns a ThreadInfoUpdateEvent object that has the latest information about the thread. This object needs to be applied to the parent message object.

Note: Like other messages, when a reply is created in a channel, the channel(_:didReceive:) method of the channel event handler in client apps will be called.

func channel(_ channel: BaseChannel, didUpdateThreadInfo threadInfoUpdateEvent: ThreadInfoUpdateEvent) {
    // Look for a message that has threadInfoUpdateEvent.targetMessageId
    // Apply the event to the message.
    message.apply(threadInfoUpdateEvent)
}

List of parameters

Parameter nameDescription

channel

Type: BaseChannel

Specifies the channel that has the message thread.

threadInfoUpdateEvent

Type: ThreadInfoUpdateEvent

Specifies a ThreadInfoUpdateEvent object that has the latest information about the thread.