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

Create a message thread

When a user replies to a message in a channel, it creates a message thread, which refers to a collection of messages consisting of a parent message and its replies. Message threading lets users ask questions, give feedback, or add context to a specific message without disrupting the flow of conversation. 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.

Message threading has the following limitations.

  • Only 1-depth threads are supported, meaning you can only add reply messages to non-reply messages. You can't add a reply to a reply message.
  • Message threading is limited to text and file messages. You can't send admin messages as replies or add replies to admin messages.

You can reply to a 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 that 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 UserMessageCreateParamsobject to the method as a parameter. The UserMessageCreateParams class is derived from the BaseMessageCreateParams class and can access all the methods and properties of BaseMessageCreateParams.

// Create a UserMessageCreateParams object.
let params = UserMessageCreateParams(message: MESSAGE_TEXT)
params.parentMessageId = PARENT_MESSAGE_ID
params.translationTargetLanguages = TARGET_LANGUAGE
params.mentionedMessageTemplate = MESSAGE_TEMPLATE

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

    // A reply to a specific message is successfully sent as a text message.
}

UserMessageCreateParams

To see the comprehensive list of all available methods and properties, see UserMessageCreateParams.

Property nameTypeDescription

parentMessageId

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 set to 0. If the message is a reply to a parent message, the value is the message ID of the parent message.

message

String

Specifies the message to send.

translationTargetLanguages

String

Specifies the languages to translate the message into.

mentionedMessageTemplate

String

Specifies the template to use for a message with mentioned users.


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. The FileMessageCreateParams class is derived from the BaseMessageCreateParams class and can access all the methods and properties of BaseMessageCreateParams.

// Create a FileMessageCreateParams object.
let params = FileMessageCreateParams(file: FILE)
params.parentMessageId = PARENT_MESSAGE_ID // This 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.
params.fileName = FILE_NAME
params.mimeType = MIME_TYPE
params.fileSize = FILE_SIZE

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

    // A reply to a specific message is successfully sent as a file message.
}

FileMessageCreateParams

To see the comprehensive list of all available methods and properties, see FileMessageCreateParams.

Property nameTypeDescription

parentMessageId

Int64

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 set to 0. If the message is a reply to a parent message, the value is the message ID of the parent message.

file

Data

Specifies the binary file data. When the value of file is specified, the value of fileURL can't be specified.

fileName

String

Specifies the file name.

mimeType

String

Specifies the file MIME type.

fileSize

UInt

Specifies the file size.