Global Do Not Disturb

The SDK supports setting a global Do Not Disturb time window and Do Not Disturb level for the current user.

• This interface sets a Do Not Disturb time window starting from any time point (HH:MM:SS). The Do Not Disturb time window will repeat daily until it is reset or removed. For example, if an App user wants to set a permanent all-day Do Not Disturb, they can set startTime to 00:00:00 and period to 1439.
• A single user can only set one time window. Repeated settings will overwrite the previously set time window.
• If the SDK version is < 5.2.2, only the Do Not Disturb time window can be set, and the Do Not Disturb level cannot be set simultaneously. It is recommended to upgrade to the latest stable or development version.

tip

During the global Do Not Disturb time window set via the SDK:

• If the client is offline, RC server will not send push notifications.
• The "Global Do Not Disturb Time Window" is a user-level setting and has the highest priority. When a user sets a "Global Do Not Disturb Time Window," the Do Not Disturb level will be determined based on this setting.

(Recommended) When the App implements local notification handling, if it detects that the client App has moved to the background, it can use the global Do Not Disturb interface provided by the SDK to decide whether to display local notifications, achieving the effect of global Do Not Disturb.

Set Do Not Disturb Time Window and Level (SDK >= 5.2.2)

Starting from SDK 5.2.2, when setting a Do Not Disturb time window for the current user, the following Do Not Disturb levels can be used:

Enum Value	Value	Description
PUSH_NOTIFICATION_QUIET_HOURS_LEVEL_DEFAULT	0	Not set. If not set, the SDK will check the user-level Do Not Disturb settings of the group to which the message belongs and other non-user-level settings before deciding whether to send a push notification.
PUSH_NOTIFICATION_QUIET_HOURS_LEVEL_MENTION_MESSAGE	1	Notify only for @ messages, including @specific user and @all messages.
PUSH_NOTIFICATION_QUIET_HOURS_LEVEL_BLOCKED	5	Do not receive notifications, even for @ messages.

Set Do Not Disturb Time Window and Level

tip

This interface is supported in ChannelClient starting from version 5.2.2.

Set the message notification Do Not Disturb time. When a message is received during the Do Not Disturb time, the SDK will determine whether to send a push notification based on the Do Not Disturb level set by this interface.

String startTime = "00:00:00";
int spanMinutes = 1439;

ChannelClient.getInstance().setNotificationQuietHoursLevel(startTime, spanMinutes,
        IRongCoreEnum.PushNotificationQuietHoursLevel.PUSH_NOTIFICATION_QUIET_HOURS_LEVEL_DEFAULT,
        new IRongCoreCallback.OperationCallback() {
                @Override
                public void onSuccess() {

                }

                @Override
                public void onError(IRongCoreEnum.CoreErrorCode coreErrorCode) {

               }
        });

Parameter	Type	Description
startTime	String	Start time, accurate to the second. Format: HH:MM:SS, e.g., 01:31:17.
spanMinutes	int	The size of the Do Not Disturb time window in minutes. Range: [1-1439].
lev	PushNotificationQuietHoursLevel	1: Notify only for @ messages, including @specific user and @all messages. If the message belongs to a one-to-one chat, it means no notification. 0: Not set. If not set, the SDK will check the user-level Do Not Disturb settings of the group to which the message belongs and other non-user-level settings before deciding whether to send a push notification. 5: Do not receive notifications, even for @ messages.
callback	ResultCallback<List<Conversation>>	Callback interface

Remove Do Not Disturb Time Window and Level

tip

This interface is supported in ChannelClient starting from version 5.2.2.

You can call the following method to remove the Do Not Disturb time window setting.

ChannelClient.getInstance().removeNotificationQuietHours(callback);

Get Do Not Disturb Time Window and Level

tip

This interface is supported in ChannelClient starting from version 5.2.2.

You can use the following method to get the Do Not Disturb time window setting. When a message is received during the Do Not Disturb time, the SDK will determine whether to send a push notification based on the current Do Not Disturb level.

ChannelClient.getInstance().getNotificationQuietHoursLevel(callback)

Parameter	Type	Description
callback	GetNotificationQuietHoursCallbackEx	Callback for getting the Do Not Disturb time. Returns startTime, spanMinutes, and level on success.