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 feature allows you to set a Do Not Disturb time window starting from any time (HH:MM:SS). The time window will repeat daily until the user's Do Not Disturb settings are modified or removed. For example, if an app user wants to set permanent 24/7 Do Not Disturb, they can set startTime to 00:00:00 and period to 1439.
• Each user can only set one time window. Repeated settings will overwrite the previous time window.

tip

During the global Do Not Disturb period set via the SDK:

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

(Recommended) When implementing local notification handling in your app, if you detect that the app has moved to the background, you can use the global Do Not Disturb API provided by the SDK to decide whether to display local notifications, achieving the effect of global Do Not Disturb.

Supported Do Not Disturb Levels

When setting the Do Not Disturb time window for the current user, the following Do Not Disturb levels can be used:

Enum Value	Value	Description
none	0	Not set. If not set, the SDK will first check the user-level Do Not Disturb settings of the message's group and other non-user-level settings before deciding whether to send a push notification.
mentionMessage	1	Only notify for @ messages, including messages that @ a specific user and @ everyone.
blocked	2	Do not receive notifications, even for @ messages.

Set Do Not Disturb Time

Set the Do Not Disturb time for message notifications. During the Do Not Disturb period, the SDK will determine whether to push message notifications based on the Do Not Disturb level set via this API.

Method

changeNotificationQuietHours(
  startTime: string, 
  spanMinutes: number, 
  level: RCIMIWPushNotificationQuietHoursLevel, 
  callback: IRCIMIWChangeNotificationQuietHoursCallback
): Promise<number>;

Parameter Description

Parameter	Type	Description
startTime	string	The start time for Do Not Disturb, formatted as HH:MM:SS
spanMinutes	number	The duration of Do Not Disturb in minutes, 0 < spanMinutes < 1440 (e.g., if the start time is 00:00 and the end time is 01:00, spanMinutes is 60 minutes. Setting it to 1439 means 24/7 Do Not Disturb (23 * 60 + 59 = 1439))
level	RCIMIWPushNotificationQuietHoursLevel	The notification level
callback	IRCIMIWChangeNotificationQuietHoursCallback	The callback for the API call result.

Return Value

Return Value	Description
number	The status code of the current API operation. 0 indicates success. For specific results, implement the callback. Non-zero values indicate the API call failed and the callback will not be triggered. Refer to the error codes for details.

Code Example

const callback = {
    onNotificationQuietHoursChanged: (code: number) => {
        //...
    },
};
let code = await engine.changeNotificationQuietHours(startTime, spanMinutes, level, callback);

Remove Do Not Disturb Time

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

Method

removeNotificationQuietHours(
  callback: IRCIMIWRemoveNotificationQuietHoursCallback
): Promise<number>;

Return Value

Return Value	Description
number	The status code of the current API operation. 0 indicates success. For specific results, implement the callback. Non-zero values indicate the API call failed and the callback will not be triggered. Refer to the error codes for details.

Code Example

const callback = {
    onNotificationQuietHoursRemoved: (code: number) => {
        //...
    },
};
let code = await engine.removeNotificationQuietHours(callback);

Get Do Not Disturb Time

You can retrieve the Do Not Disturb time window settings via the following method. During the Do Not Disturb period, the SDK will determine whether to push message notifications based on the current Do Not Disturb level.

Method

getNotificationQuietHours(
  callback: IRCIMIWGetNotificationQuietHoursCallback
): Promise<number>;

Return Value

Return Value	Description
number	The status code of the current API operation. 0 indicates success. For specific results, implement the callback. Non-zero values indicate the API call failed and the callback will not be triggered. Refer to the error codes for details.

Code Example

const callback = {
    onSuccess: (startTime: string, spanMinutes: number, level: RCIMIWPushNotificationQuietHoursLevel) => {
        //...
    },
    onError: (code: number) => {
        //...
    },
};
let code = await engine.getNotificationQuietHours(callback);