com.sendbird.android

Class UserMessage

java.lang.Object

com.sendbird.android.BaseMessage

com.sendbird.android.UserMessage

public class UserMessage
extends BaseMessage

Object representing a user message.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserMessage.RequestState Deprecated. As of 3.0.120, replaced by SendingStatus.

Nested classes/interfaces inherited from class com.sendbird.android.BaseMessage

BaseMessage.GetMessageHandler, BaseMessage.GetThreadedMessagesHandler, BaseMessage.SendingStatus

Method Summary

Modifier and Type	Method and Description
boolean	applyPollUpdateEvent(PollUpdateEvent event) Applies poll update event to this user message's poll.
boolean	applyPollVoteEvent(PollVoteEvent event) Applies poll vote event to this user message's poll.
UserMessageParams	getMessageParams() returns UserMessageParams 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
java.util.List<Plugin>	getPlugins() Returns the plugin lists for this message.
Poll	getPoll() The poll that belongs to this message object.
java.util.List<java.lang.String>	getRequestedMentionUserIds() Returns requested mention user ids.
java.lang.String	getRequestId() Returns a message request ID.
UserMessage.RequestState	getRequestState() Deprecated. As of 3.0.120, replaced by BaseMessage.getSendingStatus().
java.util.Map<java.lang.String,java.lang.String>	getTranslations() Returns the translated messages for the language codes in key.
java.lang.String	toString()

Methods inherited from class com.sendbird.android.BaseMessage

applyParentMessage, applyReactionEvent, applyThreadInfoUpdateEvent, belongsTo, belongsTo, buildFromSerializedData, buildFromSerializedData, clone, equals, getAllMetaArray, getAllMetaArrays, getAppleCriticalAlertOptions, getChannelUrl, getCreatedAt, getCustomType, getData, getErrorCode, getMentionedUsers, getMentionType, getMessage, getMessage, getMessageId, getMessageSurvivalSeconds, getMetaArray, getMetaArrays, getOgMetaData, getParentMessage, getParentMessageId, getParentMessageText, getReactions, getSender, getSendingStatus, getThreadedMessagesByTimestamp, getThreadInfo, getUpdatedAt, hashCode, isGroupChannel, isOpenChannel, isOperatorMessage, isReplyToChannel, isResendable, isSilent, serialize, setAppleCriticalAlertOptions

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRequestId

public java.lang.String getRequestId()

Returns a message request ID.

Specified by:

getRequestId in class BaseMessage

Returns:

String ID.

getTranslations

public java.util.Map<java.lang.String,java.lang.String> getTranslations()

Returns the translated messages for the language codes in key. The messages that have been sent with translation option (refer to BaseChannel.sendUserMessage(String, String, String, List, BaseChannel.SendUserMessageHandler)) will have this map.

Returns:

Translated messages key-value map.

Since:

3.0.6

getRequestState

@Deprecated
public UserMessage.RequestState getRequestState()

Deprecated. As of 3.0.120, replaced by BaseMessage.getSendingStatus().

Returns message request state.

Returns:

Request state (refer to UserMessage.RequestState).

Since:

3.0.96

getRequestedMentionUserIds

public java.util.List<java.lang.String> getRequestedMentionUserIds()

Returns requested mention user ids. If sending status is not SendingStatus#PENDING or SendingStatus#FAILED or SendingStatus#CANCELED, empty list will be returned.

Returns:

Requested mention user ids.

Since:

3.0.99

getMessageParams

public UserMessageParams getMessageParams()

returns UserMessageParams 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

Returns:

return UserMessageParams object. If sending status is SendingStatus#SUCCEEDED, return null.

Since:

3.1.0

See Also:

BaseMessageParams, UserMessageParams, FileMessageParams, getMessageParams(), FileMessage.getMessageParams()

getPlugins

public java.util.List<Plugin> getPlugins()

Returns the plugin lists for this message.

Returns:

The Collections.unmodifiableList(List) of the plugin list, or null if there's no plugin.

Since:

3.0.152

getPoll

public Poll getPoll()

The poll that belongs to this message object.

Returns:

The poll of this message.

Since:

3.0.171

applyPollUpdateEvent

public boolean applyPollUpdateEvent(PollUpdateEvent event)

Applies poll update event to this user message's poll.

Parameters:

event - event received from SendBird.ChannelHandler.onPollUpdated(PollUpdateEvent)

Returns:

true if application finished successfully. False otherwise.

Since:

3.0.171

See Also:

PollUpdateEvent

applyPollVoteEvent

public boolean applyPollVoteEvent(PollVoteEvent event)

Applies poll vote event to this user message's poll.

Parameters:

event - event received from SendBird.ChannelHandler.onPollVoted(PollVoteEvent)

Returns:

true if application finished successfully. False otherwise.

Since:

3.0.171

See Also:

PollVoteEvent

toString

public java.lang.String toString()

Overrides:

toString in class BaseMessage