com.sendbird.android

Class ScheduledUserMessageParams

java.lang.Object

com.sendbird.android.BaseMessageParams

com.sendbird.android.UserMessageParams

com.sendbird.android.ScheduledUserMessageParams

public class ScheduledUserMessageParams
extends UserMessageParams

Represents a scheduled user message params. GroupChannel.registerScheduledUserMessage(ScheduledUserMessageParams, GroupChannel.RegisterScheduledUserMessageHandler)

Since:

3.0.80

Nested Class Summary

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

BaseMessageParams.MentionType, BaseMessageParams.PushNotificationDeliveryOption

Constructor Summary

Constructors

Constructor and Description
ScheduledUserMessageParams(java.lang.String message, int year, int month, int day, int hour, int min, java.lang.String timezone) ScheduledUserMessageParams constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Date	getScheduledDateTime() Returns scheduled message date time.
java.lang.String	getScheduledTimezone() Returns scheduled message timezone.
ScheduledUserMessageParams	setAppleCriticalAlertOptions(AppleCriticalAlertOptions appleCriticalAlertOptions) set apple critical alert options for this instance.
ScheduledUserMessageParams	setPollId(java.lang.Long pollId) Sets pollId for this user message.
void	setSchedule(int year, int month, int day, int hour, int min, java.lang.String timezone) Sets schedule.
java.lang.String	toString()

Methods inherited from class com.sendbird.android.UserMessageParams

getMessage, getPollId, getTranslationTargetLanguages, setCustomType, setData, setMentionedUserIds, setMentionedUsers, setMentionType, setMessage, setMetaArrayKeys, setMetaArrays, setParentMessageId, setPushNotificationDeliveryOption, setReplyToChannel, setTargetLanguages, setTranslationTargetLanguages

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

ScheduledUserMessageParams

public ScheduledUserMessageParams(java.lang.String message,
                                  int year,
                                  int month,
                                  int day,
                                  int hour,
                                  int min,
                                  java.lang.String timezone)

ScheduledUserMessageParams constructor. The scheduled time must be set at least 6 minutes afterward from the current time. Otherwise, the scheduling will fail.

Parameters:

message - Message.

year - Year (YYYY), e.g. 2018.

month - Month (1~12).

day - Day (1~31).

hour - Hour (0~23).

min - Min (0~59).

timezone - Timezone. TimeZone.getID() can be used to get the current timezone.

Since:

3.0.80

Method Detail

setSchedule

public void setSchedule(int year,
                        int month,
                        int day,
                        int hour,
                        int min,
                        java.lang.String timezone)

Sets schedule. The scheduled time must be set at least 6 minutes afterward from the current time. Otherwise, the scheduling will fail.

Parameters:

year - Year.

month - Month.

day - Day.

hour - Hour.

min - Min.

timezone - Timezone.

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

setAppleCriticalAlertOptions

public ScheduledUserMessageParams setAppleCriticalAlertOptions(AppleCriticalAlertOptions appleCriticalAlertOptions)

Description copied from class: BaseMessageParams

set apple critical alert options for this instance.

Overrides:

setAppleCriticalAlertOptions in class UserMessageParams

Parameters:

appleCriticalAlertOptions - an instance of AppleCriticalAlertOptions

Returns:

this instance

setPollId

public ScheduledUserMessageParams setPollId(java.lang.Long pollId)

Description copied from class: UserMessageParams

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

Overrides:

setPollId in class UserMessageParams

Parameters:

pollId - id of the poll to link

Returns:

this instance

toString

public java.lang.String toString()

Overrides:

toString in class UserMessageParams