com.sendbird.android

Class BaseMessage

java.lang.Object

com.sendbird.android.BaseMessage

Direct Known Subclasses:

AdminMessage, FileMessage, UserMessage

public abstract class BaseMessage
extends java.lang.Object

Base class for messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseMessage.GetMessageHandler GetMessage handler.
static interface	BaseMessage.GetThreadedMessagesHandler GetThreadedMessages handler.
static class	BaseMessage.SendingStatus Represents message sending status.

Constructor Summary

Constructors

Constructor and Description
BaseMessage(java.lang.String channelUrl, long msgId, long createdAt)

Method Summary

Modifier and Type	Method and Description
boolean	applyReactionEvent(ReactionEvent reactionEvent) Applies ReactionEvent to message.
boolean	applyThreadInfoUpdateEvent(ThreadInfoUpdateEvent threadInfoUpdateEvent) Applies ThreadInfoUpdateEvent to a message.
static boolean	belongsTo(BaseMessage message, java.lang.String userId) Checks whether the sender's userId of the BaseMessage equals the given userId.
static boolean	belongsTo(BaseMessage message, User user) Checks whether the sender's userId of the BaseMessage equals the given user's id.
static BaseMessage	buildFromSerializedData(byte[] data) Builds UserMessage, FileMessage or AdminMessage instance from serialized data generated by serialize().
static BaseMessage	buildFromSerializedData(byte[] data, BaseMessage.SendingStatus desiredState) Builds UserMessage, FileMessage or AdminMessage instance from serialized data generated by serialize().
static BaseMessage	clone(BaseMessage msg) Clones and returns a new instance of given BaseMessage
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAllMetaArray() Deprecated. As of 3.0.99, replaced by getAllMetaArrays().
java.util.List<MessageMetaArray>	getAllMetaArrays() Returns all MessageMetaArrays.
AppleCriticalAlertOptions	getAppleCriticalAlertOptions() gets apple critical alert options of this instance.
java.lang.String	getChannelUrl() Returns the channel URL of this message belongs to.
long	getCreatedAt() Returns message creation time.
java.lang.String	getCustomType() Returns the custom type of message.
java.lang.String	getData() Returns message custom data.
int	getErrorCode() Returns error code.
java.util.List<User>	getMentionedUsers() Returns mentioned users.
BaseMessageParams.MentionType	getMentionType() Returns mention type.
java.lang.String	getMessage() Returns message text.
static void	getMessage(MessageRetrievalParams params, BaseMessage.GetMessageHandler handler) Retrieves a BaseMessage object with a specified message ID.
long	getMessageId() Returns message ID.
int	getMessageSurvivalSeconds() Returns the message's survival seconds.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getMetaArray(java.util.Collection<java.lang.String> metaArrayKeys) Deprecated. As of 3.0.99, replaced by getMetaArrays(Collection).
java.util.List<MessageMetaArray>	getMetaArrays(java.util.Collection<java.lang.String> metaArrayKeys) Returns MessageMetaArray list which is filtered by given metaArrayKeys.
OGMetaData	getOgMetaData() Retrieve OGMetaData of the message.
long	getParentMessageId() Returns the parent message's ID if this is a child message.
java.lang.String	getParentMessageText() Returns the message text of the UserMessage or the file name of the FileMessage.
java.util.List<Reaction>	getReactions() Returns reactions.
abstract java.lang.String	getRequestId() Returns a message request ID.
Sender	getSender() Returns sender of message.
BaseMessage.SendingStatus	getSendingStatus() Returns message sending status.
void	getThreadedMessagesByTimestamp(long ts, ThreadMessageListParams params, BaseMessage.GetThreadedMessagesHandler handler) Retrieves the threaded replies of the current message depending on the timestamp.
ThreadInfo	getThreadInfo() The thread info that belongs to this message object.
long	getUpdatedAt() Returns message updated time.
int	hashCode()
boolean	isGroupChannel() Checks if this message is from GroupChannel.
boolean	isOpenChannel() Checks if this message is from OpenChannel.
boolean	isOperatorMessage() Returns boolean value that can be used to test if the message was sent from an operator.
boolean	isResendable() Returns whether resend is possible.
boolean	isSilent() Checks whether the message is silent or not.
byte[]	serialize() Serializes the UserMessage, FileMessage or AdminMessage instance.
void	setAppleCriticalAlertOptions(AppleCriticalAlertOptions appleCriticalAlertOptions) sets apple critical alert options for this instance.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseMessage

public BaseMessage(java.lang.String channelUrl,
                   long msgId,
                   long createdAt)

Method Detail

getMessage

public static void getMessage(MessageRetrievalParams params,
                              BaseMessage.GetMessageHandler handler)

Retrieves a BaseMessage object with a specified message ID.

Parameters:

params - MessageRetrievalParams.

handler - Callback handler.

Since:

3.0.130

getRequestId

public abstract java.lang.String getRequestId()

Returns a message request ID.

Returns:

String ID.

getMessage

public java.lang.String getMessage()

Returns message text.

Returns:

The text.

getSender

public Sender getSender()

Returns sender of message. If SendBird.Options.useMemberAsMessageSender(boolean) is set true, the sender information such as nickname and profile url is returned as the same with the channel member's. Otherwise, the sender information will be returned as the value of the message creation time.

Returns:

The Sender of the message. Can be null.

getSendingStatus

public BaseMessage.SendingStatus getSendingStatus()

Returns message sending status.

Returns:

Message sending status (refer to BaseMessage.SendingStatus).

Since:

3.0.120

isResendable

public boolean isResendable()

Returns whether resend is possible.

Returns:

is resendable.

Since:

3.0.110

belongsTo

public static boolean belongsTo(BaseMessage message,
                                java.lang.String userId)

Checks whether the sender's userId of the BaseMessage equals the given userId.

Parameters:

message - BaseMessage to check userId.

userId - UserId to check. Returns false if userId is null or empty.

Returns:

whether the message is sent by the user with userId. Returns false if userId is null or empty or message is null.

Since:

3.0.124

belongsTo

public static boolean belongsTo(BaseMessage message,
                                User user)

Checks whether the sender's userId of the BaseMessage equals the given user's id.

Parameters:

message - BaseMessage to check user.

user - User to check. Returns false if user is null.

Returns:

whether the message is sent by the user with userId. Returns false if user or message is null.

Since:

3.0.137

buildFromSerializedData

public static BaseMessage buildFromSerializedData(byte[] data)

Builds UserMessage, FileMessage or AdminMessage instance from serialized data generated by serialize().

Parameters:

data - Serialized UserMessage, FileMessage or AdminMessage data.

Returns:

UserMessage, FileMessage or AdminMessage instance.

Since:

3.0.19

buildFromSerializedData

public static BaseMessage buildFromSerializedData(byte[] data,
                                                  BaseMessage.SendingStatus desiredState)

Builds UserMessage, FileMessage or AdminMessage instance from serialized data generated by serialize(). Unlike buildFromSerializedData(byte[]), this method takes an extra argument 'desiredState'. This argument will override the returned BaseMessage's SendingStatus. Under normal development scenarios, most application developers won't need to use this method. Changing a message's sending state may corrupt Sendbird SDK's internal states and may lead to undesired results. The rebuilt BaseMessage instance will have an error code of SendBirdError.ERR_PENDING if the instance's BaseMessage.SendingStatus changed from BaseMessage.SendingStatus.PENDING to BaseMessage.SendingStatus.FAILED.

Parameters:

data - Serialized UserMessage, FileMessage or AdminMessage data.

Returns:

UserMessage, FileMessage or AdminMessage instance.

Since:

3.0.146

serialize

public byte[] serialize()

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(byte[]).

Returns:

Serialized UserMessage, FileMessage or AdminMessage data.

Since:

3.0.19

getMessageId

public long getMessageId()

Returns message ID.

Returns:

The ID.

getParentMessageId

public long getParentMessageId()

Returns the parent message's ID if this is a child message.

Returns:

The parent message's ID.

Since:

3.0.130

getCreatedAt

public long getCreatedAt()

Returns message creation time.

Returns:

Timestamp in milliseconds.

getUpdatedAt

public long getUpdatedAt()

Returns message updated time.

Returns:

Timestamp in milliseconds.

Since:

3.0.27

getMentionType

public BaseMessageParams.MentionType getMentionType()

Returns mention type. Refer to BaseMessageParams.MentionType.

Returns:

Mention type.

Since:

3.0.64

getMentionedUsers

public java.util.List<User> getMentionedUsers()

Returns mentioned users.

Returns:

Mentioned users.

Since:

3.0.52

getChannelUrl

public java.lang.String getChannelUrl()

Returns the channel URL of this message belongs to.

Returns:

Channel URL.

isOpenChannel

public boolean isOpenChannel()

Checks if this message is from OpenChannel.

Returns:

True if the message is from OpenChannel.

isGroupChannel

public boolean isGroupChannel()

Checks if this message is from GroupChannel.

Returns:

True if the message is from GroupChannel.

getData

public java.lang.String getData()

Returns message custom data.

Returns:

The data.

getCustomType

public java.lang.String getCustomType()

Returns the custom type of message.

Returns:

Custom type.

Since:

3.0.5

getReactions

public java.util.List<Reaction> getReactions()

Returns reactions. (Immutable List)

Returns:

reactions.

Since:

3.0.112

getAllMetaArray

@Deprecated
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllMetaArray()

Deprecated. As of 3.0.99, replaced by getAllMetaArrays().

Returns all meta array key-value map.

Returns:

All meta array key-value map.

Since:

3.0.76

getAllMetaArrays

public java.util.List<MessageMetaArray> getAllMetaArrays()

Returns all MessageMetaArrays.

Returns:

MessageMetaArray

Since:

3.0.99

getMetaArray

@Deprecated
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getMetaArray(java.util.Collection<java.lang.String> metaArrayKeys)

Deprecated. As of 3.0.99, replaced by getMetaArrays(Collection).

Returns the meta array key-value map whose keys match metaArrayKeys.

Parameters:

metaArrayKeys - Meta array keys.

Returns:

The meta array key-value map whose keys match metaArrayKeys.

Since:

3.0.76

getMetaArrays

public java.util.List<MessageMetaArray> getMetaArrays(java.util.Collection<java.lang.String> metaArrayKeys)

Returns MessageMetaArray list which is filtered by given metaArrayKeys.

Parameters:

metaArrayKeys - Meta array Keys.

Returns:

List of MessageMetaArray.

Since:

3.0.99

getErrorCode

public int getErrorCode()

Returns error code.

Returns:

Error code.

Since:

3.0.110

getMessageSurvivalSeconds

public int getMessageSurvivalSeconds()

Returns the message's survival seconds.

Returns:

The message's survival seconds.

Since:

3.0.123

applyReactionEvent

public boolean applyReactionEvent(ReactionEvent reactionEvent)

Applies ReactionEvent to message.

Parameters:

reactionEvent - ReactionEvent reaction event from onReactionUpdated().

Since:

3.0.112

applyThreadInfoUpdateEvent

public boolean applyThreadInfoUpdateEvent(ThreadInfoUpdateEvent threadInfoUpdateEvent)

Applies ThreadInfoUpdateEvent to a message.

Parameters:

threadInfoUpdateEvent - ThreadInfoUpdateEvent from SendBird.ChannelHandler.onThreadInfoUpdated(BaseChannel, ThreadInfoUpdateEvent).

Returns:

true if the event has been applied successfully.

Since:

3.0.130

getThreadedMessagesByTimestamp

public void getThreadedMessagesByTimestamp(long ts,
                                           ThreadMessageListParams params,
                                           BaseMessage.GetThreadedMessagesHandler handler)

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.

Parameters:

ts - Specifies the timestamp to be the reference point of the retrieval, in Unix milliseconds format.

params - Params for getting thread message list. See ThreadMessageListParams

handler - Callback handler.

Since:

3.0.130

getThreadInfo

public ThreadInfo getThreadInfo()

The thread info that belongs to this message object.

Returns:

The thread info of this message.

Since:

3.0.130

getParentMessageText

public java.lang.String getParentMessageText()

Returns the message text of the UserMessage or the file name of the FileMessage.

Returns:

The parent message's message, or null if it doesn't have a parent message.

Since:

3.0.130

isSilent

public boolean isSilent()

Checks whether the message is silent or not.

Returns:

Returns true if the message is silent.

Since:

3.0.135

getOgMetaData

public OGMetaData getOgMetaData()

Retrieve OGMetaData of the message. Might be null if 1. Application does not support OG-TAG. (all new applications support OG-TAG by default) 2. The message does not contain a valid url. 3. The server did not fetch the OG-Tag yet. (would be updated through SendBird.ChannelHandler.onMessageUpdated(BaseChannel, BaseMessage) callback.

Returns:

an OGMetaData instance, if available.

Since:

3.0.139

See Also:

https://ogp.me/, OGMetaData

isOperatorMessage

public boolean isOperatorMessage()

Returns boolean value that can be used to test if the message was sent from an operator.

This value is true if the sender of this message was an operator at the moment this message was sent.

Note that Sender.getRole() returns the role of the sender at the current moment (when the server response was sent). So if the sender's operator status changed after sending a message, the value returned by this method and the result of

Sender#getRole() == Member.Role.OPERATOR

might differ.

Returns:

true if the sender of the message was an operator at the moment the message was sent, false otherwise.

Since:

3.0.141

See Also:

Sender.getRole()

getAppleCriticalAlertOptions

public AppleCriticalAlertOptions getAppleCriticalAlertOptions()

gets apple critical alert options of this instance.

Returns:

an AppleCriticalAlertOptions instance of this instance or null.

Since:

3.0.161

setAppleCriticalAlertOptions

public void setAppleCriticalAlertOptions(AppleCriticalAlertOptions appleCriticalAlertOptions)

sets apple critical alert options for this instance.

Parameters:

appleCriticalAlertOptions - an instance of AppleCriticalAlertOptions

Since:

3.0.161

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public static BaseMessage clone(BaseMessage msg)

Clones and returns a new instance of given BaseMessage

Parameters:

msg - BaseMessage object to clone.

Returns:

a cloned new instance of given BaseMessage.

Since:

3.0.130