UserMessage

Object representing a user message.

Properties

Link copied to clipboard
Link copied to clipboard

The apple critical alert options of the message.

Link copied to clipboard

The ChannelType of the channel this message belongs to.

Link copied to clipboard

The channel URL of the channel this message belongs to.

Link copied to clipboard

The creation time of the message in milliseconds.

Link copied to clipboard

The custom type of the message.

Link copied to clipboard

The custom data of the message.

Link copied to clipboard

The error code of them message if the sendingStatus is SendingStatus.FAILED.

Link copied to clipboard

Extra data for this BaseMessage. This is a customer-only field. It is a value used only locally, supports only memory cache, and is not stored in the database. If the message IDs are the same but the message instances are different, the extras values may not be the same. BaseMessage.extras is not shared between instances.

Link copied to clipboard

List of Form that allow users to input their information or opinions

Link copied to clipboard

Whether this message is from FeedChannel.

Link copied to clipboard

Whether this message is from GroupChannel.

Link copied to clipboard

Whether this message is from OpenChannel.

Link copied to clipboard

Whether the message was sent from an operator.

Link copied to clipboard

Determines whether the current message is a replied message and also a message was replied to the channel.

Link copied to clipboard

Whether the message is resendable.

Link copied to clipboard

Checks whether the message is silent or not.

Link copied to clipboard

The mentioned message template of the message.

Link copied to clipboard

The mentioned user ids of the message.

Link copied to clipboard

The mentioned users of the message.

Link copied to clipboard

The mention type. Refer to MentionType.

Link copied to clipboard
open var message: String

The message text of the message.

Link copied to clipboard

UserMessageCreateParams object that used for sending this message It's not null when sendingStatus is SendingStatus.PENDING or SendingStatus.FAILED If else, it will return null

Link copied to clipboard

MessageForm that allow users to input their information or opinions

Link copied to clipboard

The ID of the message.

Link copied to clipboard

The message review history of the message. It only exists when the message was reviewed.

Link copied to clipboard
Link copied to clipboard

My feedback status of the message.

Link copied to clipboard
Link copied to clipboard

This value is used internally for analyzing Sendbird Notification service data.

Link copied to clipboard

The message status of the notification message. This message status will be changed only if the channel is a FeedChannel.

Link copied to clipboard

Notification priority This value can be set when the notification message is sent and default value is NORMAL

Link copied to clipboard

The OGMetaData of the message. Might be null if

Link copied to clipboard

The parent message of this message. Only NonNull if this message is a reply message. It does not contain all properties of the parent message.

Only contains:

Link copied to clipboard

The parent message's ID if this is a reply message.

Link copied to clipboard

The plugin lists for this message, or null if there's no plugin.

Link copied to clipboard
var poll: Poll?

The poll that belongs to this message object.

Link copied to clipboard

The reactions on the message.

Link copied to clipboard
open override val requestId: String

The request ID of the message.

Link copied to clipboard

The scheduled info of the message if this is a scheduled message

Link copied to clipboard
open val sender: Sender?

The Sender of the message. If SendbirdChat.Options.useMemberInfoInMessage is set true and this message belongs to a GroupChannel (not a super group channel), the sender information, such as nickname and profile url, is returned as the same with the GroupChannel.members. Otherwise, the sender information will be returned as the value of the message creation time.

Link copied to clipboard

The sending status of the message.

Link copied to clipboard

The suggested replies of the message.

Link copied to clipboard

The thread info of the message.

Link copied to clipboard

The translated messages (key-value map) for the language codes in key. The messages that have been sent with translation option (refer to BaseChannel.sendUserMessage) will have this map.

Link copied to clipboard

The list of target translation languages with the language codes. The messages that have been sent or scheduled with translation option (refer to BaseChannel.sendUserMessage) will have this list.

Link copied to clipboard

The updated time of the message in milliseconds.

Functions

Link copied to clipboard

When parent message is updated, you can update the child message's parent message through this method If you use MessageCollection, messages in the collection are automatically updated, so don't need to call it

Link copied to clipboard
fun applyPoll(poll: Poll): Boolean

When you get updated polls from GroupChannel.getPollChangeLogsSinceToken or GroupChannel.getPollChangeLogsSinceTimestamp, you can update the user message's poll through this function If you use MessageCollection, messages in the collection are automatically updated, so don't need to call it

Link copied to clipboard

Applies ReactionEvent to message.

Link copied to clipboard

Applies ThreadInfoUpdateEvent to a message.

Link copied to clipboard

Deletes the feedback for the message. The feedback can be deleted only when the FeedbackStatus is FeedbackStatus.SUBMITTED.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard

Returns MessageMetaArray list which is filtered by given metaArrayKeys.

Link copied to clipboard

Retrieves the threaded replies of the current message depending on the timestamp. If the current message doesn’t have replies, the result is an empty list. The result is passed to handler as list.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard

Serializes the UserMessage, FileMessage or AdminMessage instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData.

Link copied to clipboard
fun submitFeedback(feedbackRating: FeedbackRating, feedbackComment: String? = null, handler: FeedbackHandler?)

Submits the feedback for the message. The feedback can be submitted only when the FeedbackStatus is FeedbackStatus.NO_FEEDBACK.

Link copied to clipboard
fun submitForm(form: Form, handler: CompletionHandler?)
fun submitForm(formKey: String, answers: Map<String, String>, handler: CompletionHandler?)

Submits the form message received from the bot.

Link copied to clipboard

Submits the form message received from the bot. The answers of the message form should be set to the MessageFormItem.draftValues before calling this method.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
fun updateFeedback(feedbackRating: FeedbackRating, feedbackComment: String? = null, handler: FeedbackHandler?)

Updates the feedback for the message. The feedback can be updated only when the FeedbackStatus is FeedbackStatus.SUBMITTED.