Categorize messages by custom type
When sending a message, you can specify a custom message type to subclassify messages. This custom type takes on the form of String
and can be useful in searching or filtering messages.
The data
and customType
properties of a message object allow you to append information to your messages. While both properties can be used flexibly, common examples for the customType
include grouping message into categories such as notes or contacts.
To embed a custom type into your message, assign a value to the customType
under the UserMessageCreateParams
or FileMessageCreateParams
object. Then, pass the specified object as an argument to the parameter in the sendUserMessage(params:completionHandler:)
or sendFileMessage(params:progressHandler:completionHandler:)
method.
To get a message's custom type, read message.customType
.