Set DND mode

Updated

Set push notifications to DND

To optimize the user experience when dealing with a large number of push notifications, Chat SDK provides fine-grained settings for push notifications and do not disturb mode at the app and conversation levels.

Push notification settings

ParameterDescriptionAppOne-to-one and group chats
ALLReceive push notifications for all offline messages.
MENTION_ONLYReceive push notifications only for mentions. This parameter is recommended for group chats. To mention one or more users, pass "em_at_list": [ "user1", "user2" ... ] to the ext field when creating a message. To mention all, pass "em_at_list": "all" to this field.
NONEDo not receive push notifications for offline messages.

The push notification setting at the conversation level takes precedence over the setting at the app level. For conversations where the push notification setting is not configured, the app setting is used by default.

For example, suppose the push notifications for the app are set to MENTION_ONLY and the push notifications for a given conversation are set to ALL. A user will receive all push notifications from that conversation, but for all other conversations, they will only receive push notifications for messages that mention them.

You can specify the DND time period and duration at the app level, and Chat will not send offline push notifications during these two periods. If both the DND time and DND duration are set, the DND mode will take effect for the sum of the two.

The following table describes the DND time settings:

SettingDescriptionAppOne-to-one and group chats
startTime & endTimeFor example, 8:30-10:0. The range of hours and minutes in the start time and end time is [0,23] and [0,59], respectively. The DND mode is set in the following way: After the start time and end time are set, the DND mode is triggered every day. For example, if the time period is set to 8:0-10:0, the DND mode is effective from 8
to 10
every day. If you set the start time to 8:0 and the end time to 12:0 at 11
, the DND mode is effective from 11
to 12
on the same day, and from 8
to 12
every day thereafter. If the start time and end time are the same, the DND mode is effective all day. However, if it is set to 0:0-0:0, the DND mode will be turned off. If the end time is earlier than the start time, the DND mode will take effect from the start time of each day to the end time of the next day. For example, if the start time is 10:0 and the end time is 8:0, the DND mode will take effect from 10
on that day to 8
on the next day. The DND mode can only be enabled during a specified time period each day. Multiple DND time periods are not supported. The new setting will override the previous setting. If both this parameter and expireTimestamp are set, the DND mode will be in effect during both time periods on the day. For example, if startTime & endTime is set to 8:0-10:0 and expireTimestamp is set to 240 minutes (4 hours) at 8
am, the app will be in DND mode from 8:00-12
on that day and from 8:00-10
every day thereafter.
expireTimestampThe DND duration, in minutes. The value range of the DND duration is [0,10080], where 0 means the parameter is invalid and 10080 means the DND mode lasts for 7 days. Unlike the setting of the DND time period, which takes effect every day, this parameter is valid once. It takes effect immediately after setting. For example, if you set the app-level expireTimestamp to 240 minutes (4 hours) at 8
am, the app will be in DND mode from 8
to 12
on the same day. If both this parameter and SILENT_MODE_INTERVAL are set, the DND mode will be effective during both time periods on the same day. For example, if the app-level startTime & endTime is set to 8:00-10
at 8
am and the DND duration is set to 240 minutes (4 hours), the app will be in DND mode from 8:00-12
now and from 8:00-10
every day thereafter.

If you need to push messages to specific users during the DND period or effective time, set Force push.

For the app and all conversations in the app, the DND setting takes precedence over the push notification setting. For example, suppose a user specifies a DND time period at the app level and sets push notifications to ALL. The app enters the DND mode during the specified time period, and the user will not receive any push notifications.

Alternatively, suppose a conversation is assigned a DND time period. The app does not have any DND settings and its push notifications are set to ALL. During the specified DND time period, the user will not receive any push notifications from this conversation, while push notifications from all other conversations will remain unchanged.

Set up push notifications for the app

Call setSilentModeForAll to set app-level push notifications. Set the push notifications and DND mode by specifying the ChatSilentModeParam field, as shown in the following example:

// convId: conversation ID.
// convType: conversation type.
// Set the push notification method to `MENTION_ONLY`.
const option = ChatSilentModeParam.constructorWithNotification(
  ChatPushRemindType.MENTION_ONLY
);
// Set the do not disturb time to 10 minutes.
const option = ChatSilentModeParam.constructorWithDuration(10);
// Set the Do Not Disturb time period to 10:10-11:00.
const option = ChatSilentModeParam.constructorWithPeriod({
  startTime: new ChatSilentModeTime({ hour: 10, minute: 10 }),
  endTime: new ChatSilentModeTime({ hour: 11, minute: 10 }),
});
// Set up offline push notifications for the app.
ChatClient.getInstance()
  .pushManager.setSilentModeForAll(option)
  .then(() => {
    console.log("Succeeded in setting the push notification.");
  })
  .catch((reason) => {
    console.log("Failed to set the push notification.", reason);
  });

Get the push notification settings of the app

Call fetchSilentModeForAll to retrieve the app-level push notification settings, as shown in the following code example:

ChatClient.getInstance()
  .pushManager.fetchSilentModeForAll()
  .then((result) => {
    console.log("Succeeded in getting the push notification settings of the app.", result);
  })
  .catch((reason) => {
    console.log("Failed to get the push notification settings of the app.", reason);
  });

Set push notifications for a single conversation

Call setSilentModeForConversation to set push notifications for a specified conversation. Set the push notifications and DND mode by specifying the ChatSilentModeParam field, as shown in the following example:

// convId: conversation ID.
// convType: conversation type.
// Set the push notification method to `MENTION_ONLY`.
const option = ChatSilentModeParam.constructorWithNotification(
  ChatPushRemindType.MENTION_ONLY
);
// Set the do not disturb time to 10 minutes.
const option = ChatSilentModeParam.constructorWithDuration(10);
// Set the Do Not Disturb time period to 10:10-11:00.
const option = ChatSilentModeParam.constructorWithPeriod({
  startTime: new ChatSilentModeTime({ hour: 10, minute: 10 }),
  endTime: new ChatSilentModeTime({ hour: 11, minute: 10 }),
});
// Set push notification for the specified conversation.
ChatClient.getInstance()
  .pushManager.setSilentModeForConversation({
    invited ,
    convType,
    option,
  })
  .then(() => {
    console.log("Succeeded in getting the push notification settings of the conversation.");
  })
  .catch((reason) => {
    console.log("Failed to get the push notification settings of the conversation.", reason);
  });

Get push notifications for a single conversation

Call fetchSilentModeForConversation to retrieve the push notification settings for a specified conversation, as shown in the following example:

// convId: conversation ID.
// convType: conversation type.
ChatClient.getInstance()
  .pushManager.fetchSilentModeForConversation({
    invited ,
    convType,
  })
  .then(() => {
    console.log("Succeeded in getting the push notification settings of the conversation.");
  })
  .catch((reason) => {
    console.log("Failed to get the push notification settings of the conversation.", reason);
  });

Get push notification settings for multiple conversations

You can get push notification settings for up to 20 conversations in each call. If a conversation uses app settings or its push notification settings have expired, the returned dictionary does not contain that conversation.

Call fetchSilentModeForConversations to retrieve push notification settings for multiple conversations, as shown in the following example:

// conversations: conversation list.
ChatClient.getInstance()
  .pushManager.fetchSilentModeForConversations(conversations)
  .then(() => {
    console.log("Succeeded in getting the conversation list.");
  })
  .catch((reason) => {
    console.log("Failed to get the conversation list.", reason);
  });

Clear push notification settings for a single conversation

Call removeSilentModeForConversation to clear the push notification mode settings for a specific conversation. After clearing, the conversation will use the app's settings by default.

The following code example shows how to clear a conversation's push notifications:

// convId: conversation ID.
// convType: conversation type.
ChatClient.getInstance()
  .pushManager.removeSilentModeForConversation({
    invited ,
    convType,
  })
  .then(() => {
    console.log("Succeeded in deleting the push notification settings of the conversation.");
  })
  .catch((reason) => {
    console.log("Failed to delete the push notification settings of the conversation.", reason);
  });