com.sendbird.android

Class ScheduledUserMessage

java.lang.Object

com.sendbird.android.ScheduledUserMessage

public final class ScheduledUserMessage
extends java.lang.Object

Object representing a scheduled user message.

Since:

3.0.80

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduledUserMessage.Status Represents scheduled message status.

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	getChannelUrl() Returns the channel URL of this message belongs to.
long	getCreatedAt() Returns scheduled message creation time.
java.lang.String	getCustomType() Returns the custom type of the scheduled message.
java.lang.String	getData() Returns the custom data of the scheduled message.
int	getErrorCode() Returns error code.
java.lang.String	getErrorMessage() Returns error message.
java.util.List<User>	getMentionedUsers() Returns mentioned users.
BaseMessageParams.MentionType	getMentionType() Returns mention type.
java.lang.String	getMessage() Returns message text.
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.
BaseMessageParams.PushNotificationDeliveryOption	getPushNotificationDeliveryOption() Returns push notification delivery option.
java.util.Date	getScheduledDateTime() Returns scheduled message date time.
long	getScheduledId() Returns scheduled message ID.
java.lang.String	getScheduledTimezone() Returns scheduled message timezone.
User	getSender() Returns sender of message.
ScheduledUserMessage.Status	getStatus() Returns scheduled message status.
java.util.ArrayList<java.lang.String>	getTranslationTargetLanguages() Returns translation target languages.
long	getUpdatedAt() Returns scheduled message updated time.
int	hashCode()
boolean	isGroupChannel() Checks if this message is from GroupChannel.
boolean	isOpenChannel() Checks if this message is from OpenChannel.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getScheduledId

public long getScheduledId()

Returns scheduled message ID.

Returns:

The ID.

Since:

3.0.80

getScheduledDateTime

public java.util.Date getScheduledDateTime()

Returns scheduled message date time.

Returns:

Scheduled message date time. Refer to Date.

Since:

3.0.80

getScheduledTimezone

public java.lang.String getScheduledTimezone()

Returns scheduled message timezone.

Returns:

Scheduled message timezone. Refer to TimeZone.getID().

Since:

3.0.80

getStatus

public ScheduledUserMessage.Status getStatus()

Returns scheduled message status.

Returns:

Scheduled message status. Refer to ScheduledUserMessage.Status.

Since:

3.0.80

getErrorCode

public int getErrorCode()

Returns error code. You may use this method when getStatus() is ScheduledUserMessage.Status.FAILED.

Returns:

Error code.

Since:

3.0.80

getErrorMessage

public java.lang.String getErrorMessage()

Returns error message. You may use this method when getStatus() is ScheduledUserMessage.Status.FAILED.

Returns:

Error message.

Since:

3.0.80

getPushNotificationDeliveryOption

public BaseMessageParams.PushNotificationDeliveryOption getPushNotificationDeliveryOption()

Returns push notification delivery option.

Returns:

Push notification delivery option.

Since:

3.0.80

getCreatedAt

public long getCreatedAt()

Returns scheduled message creation time.

Returns:

Timestamp in milliseconds.

Since:

3.0.80

getUpdatedAt

public long getUpdatedAt()

Returns scheduled message updated time.

Returns:

Timestamp in milliseconds.

Since:

3.0.80

getMentionType

public BaseMessageParams.MentionType getMentionType()

Returns mention type. Refer to BaseMessageParams.MentionType.

Returns:

Mention type.

Since:

3.0.80

getMentionedUsers

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

Returns mentioned users.

Returns:

Mentioned users.

Since:

3.0.80

getChannelUrl

public java.lang.String getChannelUrl()

Returns the channel URL of this message belongs to.

Returns:

Channel URL.

Since:

3.0.80

isOpenChannel

public boolean isOpenChannel()

Checks if this message is from OpenChannel.

Returns:

True if the message is from OpenChannel.

Since:

3.0.80

isGroupChannel

public boolean isGroupChannel()

Checks if this message is from GroupChannel.

Returns:

True if the message is from GroupChannel.

Since:

3.0.80

getData

public java.lang.String getData()

Returns the custom data of the scheduled message.

Returns:

The data.

Since:

3.0.80

getCustomType

public java.lang.String getCustomType()

Returns the custom type of the scheduled message.

Returns:

Custom type.

Since:

3.0.80

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.80

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.80

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

getMessage

public java.lang.String getMessage()

Returns message text.

Returns:

The text.

Since:

3.0.80

getSender

public User 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.

Since:

3.0.80

getTranslationTargetLanguages

public java.util.ArrayList<java.lang.String> getTranslationTargetLanguages()

Returns translation target languages. Refer to UserMessageParams.setTranslationTargetLanguages(List).

Returns:

Translation target languages.

Since:

3.0.80

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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