Gets push template option for the current User. For details of push template option, refer to setPushTemplate. This can be used, for instance, when you need to check the push notification content preview is on or off at the moment.

getPushTriggerOption

@JvmStatic

fun getPushTriggerOption(handler: PushTriggerOptionHandler?)

Gets the current User's push trigger option. Refer to PushTriggerOption. For details of push trigger option, refer to setPushTriggerOption.

getSnoozePeriod

@JvmStatic

fun getSnoozePeriod(handler: SnoozePeriodHandler?)

Gets snooze period for the current User.

registerPushToken

@JvmStatic

fun registerPushToken(token: String, handler: PushTokenWithStatusHandler?)

Registers push token for the current User to receive push notification. To enable push notification and get a token, refer to Sendbird Docs.

Push token registration succeeds only when the connection (connect) is made. Otherwise, callback will return with PushTokenRegistrationStatus.PENDING status. Then you can register push token again by calling this method with pushToken which is provided by HMS as the token parameter, after the connection is done. This just adds token to the server. If you want to register this token and delete all the previous ones, refer to registerPushToken.

@JvmStatic

fun registerPushToken(token: String, unique: Boolean, handler: PushTokenWithStatusHandler?)

setDoNotDisturb

@JvmStatic

fun setDoNotDisturb(doNotDisturbOn: Boolean, startHour: Int, startMin: Int, endHour: Int, endMin: Int, timezone: String, handler: CompletionHandler?)

Sets Do-not-disturb option for the current User. If this option is enabled, the current User does not receive push notification during the specified time repeatedly. If you want to snooze specific period, use setSnoozePeriod.

setPushSound

@JvmStatic

fun setPushSound(sound: String, handler: CompletionHandler?)

Sets the push notification sound file path for the current User. This setting will be delivered on push notification payload.

setPushTemplate

@JvmStatic

fun setPushTemplate(templateName: String, handler: CompletionHandler?)

Sets push template option for the current User. The only valid arguments for template name are PUSH_TEMPLATE_DEFAULT and PUSH_TEMPLATE_ALTERNATIVE. If PUSH_TEMPLATE_DEFAULT is set, the push notification will contain the original message in the message field of the push notification. If PUSH_TEMPLATE_ALTERNATIVE is set, message of push notification will be replaced by the content you've set on Sendbird Dashboard.

setPushTriggerOption

@JvmStatic

fun setPushTriggerOption(pushTriggerOption: SendbirdChat.PushTriggerOption, handler: CompletionHandler?)

Sets the current User's push trigger option. If certain channel's push trigger option is set to GroupChannel.PushTriggerOption.DEFAULT, it works according to the state of PushTriggerOption. If not, push messages will be triggered according to the state of GroupChannel.PushTriggerOption. Refer to GroupChannel.PushTriggerOption.

setSnoozePeriod

@JvmStatic

fun setSnoozePeriod(snoozeOn: Boolean, startTs: Long, endTs: Long, handler: CompletionHandler?)

Sets snooze period for the current User. If this option is enabled, the current User does not receive push notification during the given period. It's not a repetitive operation. If you want to snooze repeatedly, use setDoNotDisturb.

unregisterPushToken

@JvmStatic

fun unregisterPushToken(token: String, handler: CompletionHandler?)

Unregisters push token for the current User.

unregisterPushTokenAll

@JvmStatic

fun unregisterPushTokenAll(handler: CompletionHandler?)

Unregisters all push token bound to the current User.