com.sendbird.android

Class SendBird.HMS

java.lang.Object

com.sendbird.android.SendBird.HMS

Enclosing class:

SendBird

public static class SendBird.HMS
extends java.lang.Object

Push token related class specifically for Huawei Message Service, HMS.

Since:

3.0.133

Constructor Summary

Constructors

Constructor and Description
HMS()

Method Summary

Modifier and Type	Method and Description
static void	getDoNotDisturb(SendBird.GetDoNotDisturbHandler handler) Gets Do-not-disturb option for the current User.
static void	getMyPushTokensByToken(java.lang.String token, SendBird.PushTokenType type, SendBird.GetPushTokensHandler handler) Requests push tokens of current user from given token.
static java.lang.String	getPendingPushToken() Gets the pending HMS push token.
static void	getPushSound(SendBird.GetPushSoundHandler handler) Gets push notification sound path for the current User.
static void	getPushTemplate(SendBird.GetPushTemplateHandler handler) Gets push template option for the current User.
static void	getPushTriggerOption(SendBird.GetPushTriggerOptionHandler handler) Gets the current User's push trigger option.
static void	getSnoozePeriod(SendBird.GetSnoozePeriodHandler handler) Gets snooze period for the current User.
static void	registerPushTokenForCurrentUser(java.lang.String token, boolean unique, SendBird.RegisterPushTokenWithStatusHandler handler) Registers push token for the current User to receive push notification.
static void	registerPushTokenForCurrentUser(java.lang.String token, SendBird.RegisterPushTokenWithStatusHandler handler) Registers push token for the current User to receive push notification.
static void	setDoNotDisturb(boolean doNotDisturbOn, int startHour, int startMin, int endHour, int endMin, java.lang.String timezone, SendBird.SetDoNotDisturbHandler handler) Sets Do-not-disturb option for the current User.
static void	setPushSound(java.lang.String sound, SendBird.SetPushSoundHandler handler) Sets the push notification sound file path for the current User.
static void	setPushTemplate(java.lang.String templateName, SendBird.SetPushTemplateHandler handler) Sets push template option for the current User.
static void	setPushTriggerOption(SendBird.PushTriggerOption pushTriggerOption, SendBird.SetPushTriggerOptionHandler handler) Sets the current User's push trigger option.
static void	setSnoozePeriod(boolean snoozeOn, long startTs, long endTs, SendBird.SetSnoozePeriodHandler handler) Sets snooze period for the current User.
static void	unregisterPushTokenAllForCurrentUser(SendBird.UnregisterPushTokenHandler handler) Unregisters all push token bound to the current User.
static void	unregisterPushTokenForCurrentUser(java.lang.String token, SendBird.UnregisterPushTokenHandler handler) Unregisters push token for the current User.

Methods inherited from class java.lang.Object

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

Constructor Detail

HMS

public HMS()

Method Detail

getPendingPushToken

public static java.lang.String getPendingPushToken()

Gets the pending HMS push token.

Returns:

Returns the pending HMS push token. Returns null if there is no registration pending token.

Since:

3.0.133

registerPushTokenForCurrentUser

public static void registerPushTokenForCurrentUser(java.lang.String token,
                                                   SendBird.RegisterPushTokenWithStatusHandler handler)

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 (SendBird.connect(String, ConnectHandler), SendBird.connect(String, String, ConnectHandler)) is made. Otherwise, callback will return with SendBird.PushTokenRegistrationStatus.PENDING status. Then you can register push token again by calling this method with getPendingPushToken() 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 SendBird.registerPushTokenForCurrentUser(String, boolean, RegisterPushTokenWithStatusHandler).

Parameters:

token - HMS push token.

handler - Callback handler.

Since:

3.0.133

registerPushTokenForCurrentUser

public static void registerPushTokenForCurrentUser(java.lang.String token,
                                                   boolean unique,
                                                   SendBird.RegisterPushTokenWithStatusHandler handler)

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 (SendBird.connect(String, ConnectHandler), SendBird.connect(String, String, ConnectHandler)) is made. Otherwise, callback will return with SendBird.PushTokenRegistrationStatus.PENDING status. Then you can register push token again by calling this method with getPendingPushToken() as the token parameter, after the connection is done.

Parameters:

token - HMS push token.

unique - If true, all the previously registered token for the current User will be deleted and this token will be the unique one.

handler - Callback handler.

Since:

3.0.133

unregisterPushTokenForCurrentUser

public static void unregisterPushTokenForCurrentUser(java.lang.String token,
                                                     SendBird.UnregisterPushTokenHandler handler)

Unregisters push token for the current User.

Parameters:

token - HMS push token.

handler - Callback handler.

Since:

3.0.133

unregisterPushTokenAllForCurrentUser

public static void unregisterPushTokenAllForCurrentUser(SendBird.UnregisterPushTokenHandler handler)

Unregisters all push token bound to the current User.

Parameters:

handler - Callback handler.

Since:

3.0.133

getMyPushTokensByToken

public static void getMyPushTokensByToken(java.lang.String token,
                                          SendBird.PushTokenType type,
                                          SendBird.GetPushTokensHandler handler)

Requests push tokens of current user from given token. The result is passed to handler.

Parameters:

token - Token to get next push tokens. If token is null, the result will be passed from the beginning.

type - PushTokenType. Refer to SendBird.PushTokenType.

handler - Callback handler.

Since:

3.0.133

setDoNotDisturb

public static void setDoNotDisturb(boolean doNotDisturbOn,
                                   int startHour,
                                   int startMin,
                                   int endHour,
                                   int endMin,
                                   java.lang.String timezone,
                                   SendBird.SetDoNotDisturbHandler handler)

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 SendBird.setSnoozePeriod(boolean, long, long, SetSnoozePeriodHandler).

Parameters:

doNotDisturbOn - Enables option or not.

startHour - Start hour (0~23).

startMin - Start minute (0~59).

endHour - End hour (0~23).

endMin - End minute (0~59).

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

handler - Callback handler.

Since:

3.0.133

getDoNotDisturb

public static void getDoNotDisturb(SendBird.GetDoNotDisturbHandler handler)

Gets Do-not-disturb option for the current User.

Parameters:

handler - Callback handler.

Since:

3.0.133

setSnoozePeriod

public static void setSnoozePeriod(boolean snoozeOn,
                                   long startTs,
                                   long endTs,
                                   SendBird.SetSnoozePeriodHandler handler)

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 SendBird.setDoNotDisturb(boolean, int, int, int, int, String, SetDoNotDisturbHandler).

Parameters:

snoozeOn - Enables option or not.

startTs - Start timestamp of snooze period

endTs - End timestamp of snooze period

handler - Callback handler.

Since:

3.0.133

getSnoozePeriod

public static void getSnoozePeriod(SendBird.GetSnoozePeriodHandler handler)

Gets snooze period for the current User.

Parameters:

handler - Callback handler.

Since:

3.0.133

setPushSound

public static void setPushSound(java.lang.String sound,
                                SendBird.SetPushSoundHandler handler)

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

Parameters:

sound - Sound file path.

handler - Callback handler.

Since:

3.0.133

getPushSound

public static void getPushSound(SendBird.GetPushSoundHandler handler)

Gets push notification sound path for the current User.

Parameters:

handler - Callback handler.

Since:

3.0.133

setPushTemplate

public static void setPushTemplate(java.lang.String templateName,
                                   SendBird.SetPushTemplateHandler handler)

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

Parameters:

templateName - Name of template to be applied to current User.

handler - Callback handler.

Since:

3.0.133

getPushTemplate

public static void getPushTemplate(SendBird.GetPushTemplateHandler handler)

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

Parameters:

handler - Callback handler.

Since:

3.0.133

setPushTriggerOption

public static void setPushTriggerOption(SendBird.PushTriggerOption pushTriggerOption,
                                        SendBird.SetPushTriggerOptionHandler handler)

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 SendBird.PushTriggerOption. If not, push messages will be triggered according to the state of GroupChannel.PushTriggerOption. Refer to GroupChannel.PushTriggerOption.

Parameters:

pushTriggerOption - PushTriggerOption. Refer to SendBird.PushTriggerOption.

handler - Callback handler.

Since:

3.0.133

getPushTriggerOption

public static void getPushTriggerOption(SendBird.GetPushTriggerOptionHandler handler)

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

Parameters:

handler - Callback handler.

Since:

3.0.133