SendbirdChat/com.sendbird.android.message/CustomizableMessage

CustomizableMessage

open class CustomizableMessage @JvmOverloads constructor(channelUrl: String, messageId: Long, createdAt: Long, val requestId: String = "") : BaseMessage

This class is to provide a customizable BaseMessage class so that a custom message object such as a timeline or bookmark message can be used with other actual BaseMessage objects in a single List<BaseMessage>.

This is only to be used as a read-only object and any other BaseMessage operation is not guaranteed and may throw an SendbirdNotSupportedException or lead to a crash.

Constructors

CustomizableMessage

@JvmOverloads

constructor(channelUrl: String, messageId: Long, createdAt: Long, requestId: String = "")

Properties

allMetaArrays

val allMetaArrays: List<MessageMetaArray>

All MessageMetaArrays of the message.

appleCriticalAlertOptions

var appleCriticalAlertOptions: AppleCriticalAlertOptions?

The apple critical alert options of the message.

channelType

var channelType: ChannelType

The ChannelType of the channel this message belongs to.

channelUrl

var channelUrl: String

The channel URL of the channel this message belongs to.

createdAt

var createdAt: Long

The creation time of the message in milliseconds.

customType

var customType: String

The custom type of the message.

data

var data: String

The custom data of the message.

errorCode

val errorCode: Int

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

extras

val extras: MutableMap<String, Any>

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.

forms

var ~~forms~~: List<Form>

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

isFeedChannel

val isFeedChannel: Boolean

Whether this message is from FeedChannel.

isGroupChannel

val isGroupChannel: Boolean

Whether this message is from GroupChannel.

isOpenChannel

val isOpenChannel: Boolean

Whether this message is from OpenChannel.

isOperatorMessage

var isOperatorMessage: Boolean

Whether the message was sent from an operator.

isReplyToChannel

var isReplyToChannel: Boolean

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

isResendable

open val isResendable: Boolean

Whether the message is resendable.

isSilent

var isSilent: Boolean

Checks whether the message is silent or not.

mentionedMessageTemplate

var mentionedMessageTemplate: String?

The mentioned message template of the message.

mentionedUserIds

val mentionedUserIds: List<String>

The mentioned user ids of the message.

mentionedUsers

val mentionedUsers: List<User>

The mentioned users of the message.

mentionType

var mentionType: MentionType

The mention type. Refer to MentionType.

message

open var message: String

The message text of the message.

messageCreateParams

open val messageCreateParams: BaseMessageCreateParams?

The BaseMessageCreateParams object that used for sending this message For more details, Please refer UserMessage.messageCreateParams, FileMessage.messageCreateParams

messageForm

var messageForm: MessageForm?

MessageForm that allow users to input their information or opinions

messageId

var messageId: Long

The ID of the message.

myFeedback

var myFeedback: Feedback?

My feedback of the message. Not null, if its FeedbackStatus is FeedbackStatus.SUBMITTED. Null, if its FeedbackStatus is FeedbackStatus.NOT_APPLICABLE or FeedbackStatus.NO_FEEDBACK.

myFeedbackStatus

var myFeedbackStatus: FeedbackStatus

My feedback status of the message.

notificationData

val notificationData: NotificationData?

notificationEventDeadline

var notificationEventDeadline: Long?

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

notificationMessageStatus

var notificationMessageStatus: NotificationMessageStatus

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

notificationPriority

var notificationPriority: NotificationPriority

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

ogMetaData

var ogMetaData: OGMetaData?

The OGMetaData of the message. Might be null if

parentMessage

var parentMessage: BaseMessage?

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:

parentMessageId

var parentMessageId: Long

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

poll

open var poll: Poll?

The poll that belongs to this message object.

reactions

val reactions: List<Reaction>

The reactions on the message.

requestId

open override val requestId: String

The request ID of the message.

scheduledInfo

var scheduledInfo: ScheduledInfo?

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

sender

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.

sendingStatus

open var sendingStatus: SendingStatus

The sending status of the message.

suggestedReplies

var suggestedReplies: List<String>

The suggested replies of the message.

threadInfo

val threadInfo: ThreadInfo

The thread info of the message.

updatedAt

var updatedAt: Long

The updated time of the message in milliseconds.

Functions

applyParentMessage

fun applyParentMessage(parentMessage: BaseMessage): Boolean

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

applyPoll

open 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

applyReactionEvent

fun applyReactionEvent(reactionEvent: ReactionEvent): Boolean

Applies ReactionEvent to message.

applyThreadInfoUpdateEvent

fun applyThreadInfoUpdateEvent(threadInfoUpdateEvent: ThreadInfoUpdateEvent): Boolean

Applies ThreadInfoUpdateEvent to a message.

deleteFeedback

fun deleteFeedback(handler: CompletionHandler?)

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

equals

open operator override fun equals(other: Any?): Boolean

getMetaArrays

fun getMetaArrays(metaArrayKeys: Collection<String>): List<MessageMetaArray>

Returns MessageMetaArray list which is filtered by given metaArrayKeys.

getThreadedMessagesByTimestamp

fun getThreadedMessagesByTimestamp(ts: Long, params: ThreadMessageListParams, handler: ThreadedMessagesHandler?)

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.

hashCode

open override fun hashCode(): Int

serialize

fun serialize(): ByteArray

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.

submitFeedback

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.

submitForm

fun ~~submitForm~~(form: Form, handler: CompletionHandler?)

fun ~~submitForm~~(formKey: String, answers: Map<String, String>, handler: CompletionHandler?)

Submits the form message received from the bot.

submitMessageForm

fun submitMessageForm(handler: CompletionHandler?)

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.

toString

open override fun toString(): String

updateFeedback

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.