com.sendbird.android

Class UserMessageParams

java.lang.Object

com.sendbird.android.BaseMessageParams

com.sendbird.android.UserMessageParams

Direct Known Subclasses:

ScheduledUserMessageParams

public class UserMessageParams
extends BaseMessageParams

Represents a user message params. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Since:

3.0.52

Nested Class Summary

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

BaseMessageParams.MentionType, BaseMessageParams.PushNotificationDeliveryOption

Constructor Summary

Constructors

Constructor and Description
UserMessageParams() UserMessageParams constructor.
UserMessageParams(java.lang.String message) UserMessageParams constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage() Returns message.
java.lang.Long	getPollId() Returns poll id.
java.util.List<java.lang.String>	getTranslationTargetLanguages() Returns translation target languages.
UserMessageParams	setAppleCriticalAlertOptions(AppleCriticalAlertOptions appleCriticalAlertOptions) set apple critical alert options for this instance.
UserMessageParams	setCustomType(java.lang.String customType) Sets custom type.
UserMessageParams	setData(java.lang.String data) Sets data.
UserMessageParams	setMentionedUserIds(java.util.List<java.lang.String> mentionedUserIds) Set mentioned user ids.
UserMessageParams	setMentionedUsers(java.util.List<User> mentionedUsers) Set mentioned users.
UserMessageParams	setMentionType(BaseMessageParams.MentionType mentionType) Sets mention type.
UserMessageParams	setMessage(java.lang.String message) Sets message.
UserMessageParams	setMetaArrayKeys(java.util.List<java.lang.String> metaArrayKeys) Deprecated. As of 3.0.129, replaced by setMetaArrays(List).
UserMessageParams	setMetaArrays(java.util.List<MessageMetaArray> metaArrays) Sets meta arrays.
UserMessageParams	setParentMessageId(long parentMessageId) Sets the parent message's id to create a child message.
UserMessageParams	setPollId(java.lang.Long pollId) Sets pollId for this user message.
UserMessageParams	setPushNotificationDeliveryOption(BaseMessageParams.PushNotificationDeliveryOption pushNotificationDeliveryOption) Sets push notification delivery option.
UserMessageParams	setReplyToChannel(boolean replyToChannel) Set whether to send the thread message to the channel as well.
UserMessageParams	setTargetLanguages(java.util.List<java.lang.String> targetLanguages) Deprecated. As of 3.0.80, replaced by setTranslationTargetLanguages(List).
UserMessageParams	setTranslationTargetLanguages(java.util.List<java.lang.String> translationTargetLanguages) Sets translation target languages.
java.lang.String	toString()

Methods inherited from class com.sendbird.android.BaseMessageParams

getAppleCriticalAlertOptions, getCustomType, getData, getMentionedUserIds, getMentionType, getMetaArrays, getParentMessageId, getPushNotificationDeliveryOption, getReplyToChannel, getRootMessageId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UserMessageParams

public UserMessageParams()

UserMessageParams constructor.

Since:

3.0.71

UserMessageParams

public UserMessageParams(java.lang.String message)

UserMessageParams constructor.

Parameters:

message - message

Since:

3.0.52

Method Detail

getMessage

public java.lang.String getMessage()

Returns message. If it hasn't set before, it returns empty string

Returns:

message. If it hasn't set before, it returns empty string

Since:

3.1.0

setMessage

public UserMessageParams setMessage(java.lang.String message)

Sets message. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

message - message

Returns:

UserMessageParams

Since:

3.0.71

setTargetLanguages

@Deprecated
public UserMessageParams setTargetLanguages(java.util.List<java.lang.String> targetLanguages)

Deprecated. As of 3.0.80, replaced by setTranslationTargetLanguages(List).

Sets targetLanguages. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

targetLanguages - targetLanguages

Returns:

UserMessageParams

Since:

3.0.52

getTranslationTargetLanguages

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

Returns translation target languages. If it hasn't set before, it returns null

Returns:

translation target languages. If it hasn't set before, it returns null

Since:

3.1.0

setTranslationTargetLanguages

public UserMessageParams setTranslationTargetLanguages(java.util.List<java.lang.String> translationTargetLanguages)

Sets translation target languages. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

translationTargetLanguages - languages.

Returns:

UserMessageParams

Since:

3.0.80

setData

public UserMessageParams setData(java.lang.String data)

Sets data. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

data - data

Returns:

UserMessageParams

Since:

3.0.52

setCustomType

public UserMessageParams setCustomType(java.lang.String customType)

Sets custom type. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

customType - custom type

Returns:

UserMessageParams

Since:

3.0.52

setMentionType

public UserMessageParams setMentionType(BaseMessageParams.MentionType mentionType)

Sets mention type. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

mentionType - mention type. Refer to BaseMessageParams.MentionType.

Returns:

UserMessageParams

Since:

3.0.64

setMentionedUsers

public UserMessageParams setMentionedUsers(java.util.List<User> mentionedUsers)

Set mentioned users. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

mentionedUsers - mentionedUsers

Returns:

UserMessageParams

Since:

3.0.52

setMentionedUserIds

public UserMessageParams setMentionedUserIds(java.util.List<java.lang.String> mentionedUserIds)

Set mentioned user ids. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

mentionedUserIds - mentionedUserIds

Returns:

UserMessageParams

Since:

3.0.52

setPushNotificationDeliveryOption

public UserMessageParams setPushNotificationDeliveryOption(BaseMessageParams.PushNotificationDeliveryOption pushNotificationDeliveryOption)

Sets push notification delivery option. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

pushNotificationDeliveryOption - push notification delivery option

Returns:

UserMessageParams

Since:

3.0.56

setMetaArrayKeys

@Deprecated
public UserMessageParams setMetaArrayKeys(java.util.List<java.lang.String> metaArrayKeys)

Deprecated. As of 3.0.129, replaced by setMetaArrays(List).

Sets meta array keys. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

metaArrayKeys - metaArrayKeys

Returns:

UserMessageParams

Since:

3.0.76

setMetaArrays

public UserMessageParams setMetaArrays(java.util.List<MessageMetaArray> metaArrays)

Sets meta arrays. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler)

Parameters:

metaArrays - metaArrays

Returns:

UserMessageParams

Since:

3.0.129

setParentMessageId

public UserMessageParams setParentMessageId(long parentMessageId)

Sets the parent message's id to create a child message. BaseChannel.sendUserMessage(UserMessageParams, BaseChannel.SendUserMessageHandler).

Parameters:

parentMessageId - Parent BaseMessage's id if you want to make it a threaded message.

Returns:

UserMessageParams

Since:

3.0.130

setAppleCriticalAlertOptions

public UserMessageParams setAppleCriticalAlertOptions(AppleCriticalAlertOptions appleCriticalAlertOptions)

Description copied from class: BaseMessageParams

set apple critical alert options for this instance.

Overrides:

setAppleCriticalAlertOptions in class BaseMessageParams

Parameters:

appleCriticalAlertOptions - an instance of AppleCriticalAlertOptions

Returns:

this instance

getPollId

public java.lang.Long getPollId()

Returns poll id. If it hasn't set before, it returns null. If setPollId(null) was lastly called, it returns -1. -1 means remove poll from the message

Returns:

poll id. If it hasn't set before, it returns null. If setPollId(null) was lastly called, it returns -1.

Since:

3.1.0

setPollId

public UserMessageParams setPollId(java.lang.Long pollId)

Sets pollId for this user message. Explicitly pass null to remove poll from this message.

Parameters:

pollId - id of the poll to link

Returns:

this instance

Since:

3.0.171

setReplyToChannel

public UserMessageParams setReplyToChannel(boolean replyToChannel)

Set whether to send the thread message to the channel as well.

Overrides:

setReplyToChannel in class BaseMessageParams

Parameters:

replyToChannel - whether to send the thread message to the channel as well.

Returns:

UserMessageParams

Since:

3.0.173

toString

public java.lang.String toString()

Overrides:

toString in class BaseMessageParams