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 point (HH:MM:SS). The set time window will repeat daily until it is modified or removed. For example, if an app user wants to set permanent Do Not Disturb for the entire day, they can set startTime to 00:00:00 and period to 1439.
• Each user can only set one time window. Repeating the setting 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.

tip

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

• If the client is offline, RC's 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 the "Global Do Not Disturb Time Window," the Do Not Disturb level set here will take precedence.

(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 determine 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 the Do Not Disturb time window for the current user, the following Do Not Disturb levels can be used:

Enum Value	Value	Description
RCPushNotificationQuietHoursLevelDefault	0	Not set. If not set, the SDK will check the user-level Do Not Disturb settings of the message's group and other non-user-level settings to determine whether to send a push notification.
RCPushNotificationQuietHoursLevelMention	1	Only notify for @ messages, including @specific user and @all messages.
RCPushNotificationQuietHoursLevelBlocked	5	Do not receive notifications, even for @ messages.

SDK versions earlier than 5.2.2 only support setting whether to receive push notifications or not.

Set Do Not Disturb Time Window and Level

tip

This API is available in RCChannelClient and is supported starting from version 5.2.2.

Set the Do Not Disturb time window for message notifications. During the Do Not Disturb time window, whether to send a push notification will be determined based on the Do Not Disturb level set via this API.

[[RCChannelClient sharedChannelManager] setNotificationQuietHoursLevel:@"00:00:00"
                                                           spanMins:1439
                                                              level:(RCPushNotificationQuietHoursLevel)level
                                                            success:^() {} error:^(RCErrorCode status) {}];

Parameter	Type	Description
startTime	NSString	Start time, accurate to seconds. Format: HH:MM:SS, e.g., 01:31:17.
spanMins	int	Duration of the Do Not Disturb time window in minutes. Supported range: [1-1439].
level	RCPushNotificationQuietHoursLevel	1: Only notify for @ messages, including @specific user and @all messages. If the message's conversation type is one-to-one, no notification will be sent. 0: Not set. If not set, the SDK will check the user-level Do Not Disturb settings of the message's group and other non-user-level settings to determine whether to send a push notification. 5: Do not receive notifications, even for @ messages.
successBlock	Block	Success callback
errorBlock	Block	Failure callback. The status parameter contains the error code. See RCErrorCode.

Remove Do Not Disturb Time Window and Level

tip

This API is available in RCChannelClient and is supported starting from version 5.2.2.

You can call the following method and set level to RCPushNotificationQuietHoursLevelDefault to remove the Do Not Disturb time window setting.

[[RCChannelClient sharedChannelManager] setNotificationQuietHoursLevel:@"00:00:00"
                                                           spanMins:1439
                                                              level:(RCPushNotificationQuietHoursLevel)level
                                                            success:^() {} error:^(RCErrorCode status)

Get Do Not Disturb Time Window and Level

tip

This API is available in RCChannelClient and is supported starting from version 5.2.2.

You can use the following method to retrieve the Do Not Disturb time window setting. During the Do Not Disturb time window, whether to send a push notification will be determined based on the current Do Not Disturb level.

[[RCChannelClient sharedChannelManager] getNotificationQuietHoursLevel:^(NSString *startTime, int spanMins, RCPushNotificationQuietHoursLevel level) {

    } error:^(RCErrorCode status) {

    }];

Parameter	Type	Description
successBlock	BOOL	Success callback. startTime is the start time of the global Do Not Disturb (format: HH:MM:SS). spanMins is the duration of the global Do Not Disturb (in minutes). level is the RCPushNotificationQuietHoursLevel passed during setup.
errorBlock	BOOL	Failure callback. status is the error code. See RCErrorCode.

Set Global Do Not Disturb Time Window (< 5.2.2)

SDK versions earlier than 5.2.2 only support setting the Do Not Disturb time window. During the global Do Not Disturb time window, no message notifications will be sent.

Exception: @ messages are high-priority messages and will bypass the global Do Not Disturb logic, and notifications will still be sent.

Set Global Do Not Disturb Time Window

tip

This API is available in RCIMClient and is deprecated starting from version 5.2.2.

Set the global Do Not Disturb time window to block all notifications, including local and remote push notifications.

[[RCIMClient sharedRCIMClient] setNotificationQuietHours:@"00:00:00"
                                                spanMins:1439
                                                 success:^{}
                                                   error:^(RCErrorCode status) {}];

Parameter	Type	Description
startTime	NSString	Start time, accurate to seconds. Format: HH:MM:SS, e.g., 01:31:17.
spanMins	int	Duration of the Do Not Disturb time window in minutes. Supported range: [1-1439].
successBlock	BOOL	Success callback
errorBlock	BOOL	Failure callback. The status parameter contains the error code. See RCErrorCode.

Get Global Do Not Disturb Time Window

tip

This API is available in RCIMClient and is deprecated starting from version 5.2.2.

Use the following method to retrieve the current app's Do Not Disturb time window setting.

[[RCIMClient sharedRCIMClient] getNotificationQuietHours:^(NSString *startTime, int spanMins) {

    } error:^(RCErrorCode status) {

    }];

Parameter	Type	Description
successBlock	BOOL	Success callback. startTime is the start time of the global Do Not Disturb (format: HH:MM:SS). spanMins is the duration of the global Do Not Disturb (in minutes).
errorBlock	BOOL	Failure callback. status is the error code. See RCErrorCode.

Remove Global Do Not Disturb Time Window

tip

This API is available in RCIMClient and is deprecated starting from version 5.2.2.

Use the following method to remove the previously set Do Not Disturb time window. After successful removal, local and push notifications will be received normally.

[[RCIMClient sharedRCIMClient] removeNotificationQuietHours:^{

        } error:^(RCErrorCode status) {

        }];

Parameter	Type	Description
successBlock	BOOL	Success callback.
errorBlock	BOOL	Failure callback. status is the error code. See RCErrorCode.