
public final class ScheduledUserMessage

Object representing a scheduled user message.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`ScheduledUserMessage.Status`	Represents scheduled message status.

Method Summary

Modifier and Type	Method	Description
`long`	`getScheduledId()`	Returns scheduled message ID.
`Date`	`getScheduledDateTime()`	Returns scheduled message date time.
`String`	`getScheduledTimezone()`	Returns scheduled message timezone.
`ScheduledUserMessage.Status`	`getStatus()`	Returns scheduled message status.
`int`	`getErrorCode()`	Returns error code.
`String`	`getErrorMessage()`	Returns error message.
`BaseMessageParams.PushNotificationDeliveryOption`	`getPushNotificationDeliveryOption()`	Returns push notification delivery option.
`long`	`getCreatedAt()`	Returns scheduled message creation time.
`long`	`getUpdatedAt()`	Returns scheduled message updated time.
`BaseMessageParams.MentionType`	`getMentionType()`	Returns mention type.
`List<User>`	`getMentionedUsers()`	Returns mentioned users.
`String`	`getChannelUrl()`	Returns the channel URL of this message belongs to.
`boolean`	`isOpenChannel()`	Checks if this message is from `OpenChannel`.
`boolean`	`isGroupChannel()`	Checks if this message is from `GroupChannel`.
`String`	`getData()`	Returns the custom data of the scheduled message.
`String`	`getCustomType()`	Returns the custom type of the scheduled message.
`Map<String, List<String>>`	`getAllMetaArray()`	Returns all meta array key-value map.
`List<MessageMetaArray>`	`getAllMetaArrays()`	Returns all MessageMetaArrays.
`Map<String, List<String>>`	`getMetaArray(Collection<String> metaArrayKeys)`	Returns the meta array key-value map whose keys match metaArrayKeys.
`List<MessageMetaArray>`	`getMetaArrays(Collection<String> metaArrayKeys)`	Returns MessageMetaArray list which is filtered by given metaArrayKeys.
`String`	`getMessage()`	Returns message text.
`User`	`getSender()`	Returns sender of message.
`ArrayList<String>`	`getTranslationTargetLanguages()`	Returns translation target languages.
`String`	`toString()`
`boolean`	`equals(Object o)`
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getScheduledId
```
 long getScheduledId()
```
    Returns scheduled message ID.
  - getScheduledDateTime
```
 Date getScheduledDateTime()
```
    Returns scheduled message date time.
  - getScheduledTimezone
```
 String getScheduledTimezone()
```
    Returns scheduled message timezone.
  - getStatus
```
 ScheduledUserMessage.Status getStatus()
```
    Returns scheduled message status.
  - getErrorCode
```
 int getErrorCode()
```
    Returns error code.You may use this method when getStatus is FAILED.
  - getErrorMessage
```
 String getErrorMessage()
```
    Returns error message.You may use this method when getStatus is FAILED.
  - getPushNotificationDeliveryOption
```
 BaseMessageParams.PushNotificationDeliveryOption getPushNotificationDeliveryOption()
```
    Returns push notification delivery option.
  - getCreatedAt
```
 long getCreatedAt()
```
    Returns scheduled message creation time.
  - getUpdatedAt
```
 long getUpdatedAt()
```
    Returns scheduled message updated time.
  - getMentionType
```
 BaseMessageParams.MentionType getMentionType()
```
    Returns mention type. Refer to BaseMessageParams.MentionType.
  - getMentionedUsers
```
 List<User> getMentionedUsers()
```
    Returns mentioned users.
  - getChannelUrl
```
 String getChannelUrl()
```
    Returns the channel URL of this message belongs to.
  - isOpenChannel
```
 boolean isOpenChannel()
```
    Checks if this message is from OpenChannel.
  - isGroupChannel
```
 boolean isGroupChannel()
```
    Checks if this message is from GroupChannel.
  - getData
```
 String getData()
```
    Returns the custom data of the scheduled message.
  - getCustomType
```
 String getCustomType()
```
    Returns the custom type of the scheduled message.
  - getAllMetaArray
```
@Deprecated() Map<String, List<String>> getAllMetaArray()
```
    Returns all meta array key-value map.
  - getAllMetaArrays
```
 List<MessageMetaArray> getAllMetaArrays()
```
    Returns all MessageMetaArrays.
  - getMetaArray
```
@Deprecated() Map<String, List<String>> getMetaArray(Collection<String> metaArrayKeys)
```
    Returns the meta array key-value map whose keys match metaArrayKeys.
    
    Parameters:
    
    metaArrayKeys - Meta array keys.
  - getMetaArrays
```
 List<MessageMetaArray> getMetaArrays(Collection<String> metaArrayKeys)
```
    Returns MessageMetaArray list which is filtered by given metaArrayKeys.
    
    Parameters:
    
    metaArrayKeys - Meta array Keys.
  - getMessage
```
 String getMessage()
```
    Returns message text.
  - getSender
```
 User getSender()
```
    Returns sender of message. If useMemberAsMessageSender 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.
  - getTranslationTargetLanguages
```
 ArrayList<String> getTranslationTargetLanguages()
```
    Returns translation target languages.Refer to setTranslationTargetLanguages.
  - toString
```
 String toString()
```
  - equals
```
 boolean equals(Object o)
```
  - hashCode
```
 int hashCode()
```

Class ScheduledUserMessage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getScheduledId

getScheduledDateTime

getScheduledTimezone

getStatus

getErrorCode

getErrorMessage

getPushNotificationDeliveryOption

getCreatedAt

getUpdatedAt

getMentionType

getMentionedUsers

getChannelUrl

isOpenChannel

isGroupChannel

getData

getCustomType

getAllMetaArray

getAllMetaArrays

getMetaArray

getMetaArrays

getMessage

getSender

getTranslationTargetLanguages

toString

equals

hashCode