Push notification preferences

By registering or unregistering the current user's registration token to the Sendbird server as below, you can turn push notifications on or off in the user's app. The registration and unregistration methods in the code below should be called after a user has established a connection with the Sendbird server via the connect() method.

Through setPushTriggerOption() and setMyPushTriggerOption(), the current user can set which message can trigger a push notification or completely turn it off as well. Besides, they can enable the Do Not Disturb (DND) and snooze features through setDoNotDisturb() and setSnoozePeriod() methods.

Note: Push notifications are only supported in group channels.

const setPushNotification = (enable, os) => {
    if (enable) {
        if (os === 'ios') {
            await sb.registerAPNSPushTokenForCurrentUser(TOKEN);
        } else {
            await sb.registerFCMPushTokenForCurrentUser(TOKEN);
        }
    } else {
        if (os === 'ios') {
            await sb.unregisterAPNSPushTokenForCurrentUser(TOKEN);
        } else {
            await sb.unregisterFCMPushTokenForCurrentUser(TOKEN);
        }
    }
}

Push trigger options allow users to configure when to receive notification messages as well as what type of messages will trigger notification messages on the application level. The following three options are provided.

await sb.setPushTriggerOption('mention_only');

Push trigger options for channel also allow users to configure the trigger for notification messages as well as turn notifications on or off for each group channel. The following four options are provided.

await groupChannel.setMyPushTriggerOption('default');

If you want to routinely turn off push notifications on the current user's client app according to a specified schedule, use the Do Not Disturb feature.

When evaluating whether to suppress a notification, the server checks in the following priority order:

1. Snooze: If snooze is active, notifications are paused regardless of other settings.
2. Day-of-week DND schedules: If weekly DND schedules are configured, the server checks the current time against the configured windows.
3. Legacy DND: If no weekly DND schedules exist, the legacy setDoNotDisturb() settings are used.

Day-of-week DND schedules and legacy DND are mutually exclusive — setting weekly DND schedules automatically disables legacy DND.

Note: The setDoNotDisturb() and getDoNotDisturb() methods have been deprecated as of v4.22.0. Use setWeeklyDoNotDisturb() and getWeeklyDoNotDisturb() instead for more flexible scheduling options.

Note: Do Not Disturb can also be set for a user with the Platform API's update push preferences action.

// Deprecated: Use setWeeklyDoNotDisturb() instead.
await sb.setDoNotDisturb(true, START_HOUR, START_MIN, END_HOUR, END_MIN, 'Asia/Seoul');

Weekly Do Not Disturb allows you to set different Do Not Disturb time windows for each day of the week. This replaces the single-window setDoNotDisturb() method with more flexible scheduling.

Note: When evaluating whether to suppress a notification, the server checks snooze first, then weekly DND schedules, then legacy DND. Setting weekly DND schedules automatically disables legacy DND.

import { DndSchedule, DayOfWeek } from '@sendbird/chat';

const dndSchedule = new DndSchedule();

// Set weekdays to 22:00 ~ 23:59
dndSchedule.setWeekdays([
  { startHour: 22, startMin: 0, endHour: 23, endMin: 59 },
]);

// Set weekends to full-day DND
dndSchedule.setFullDay([DayOfWeek.SATURDAY, DayOfWeek.SUNDAY]);

const preference = await sb.setWeeklyDoNotDisturb(dndSchedule, 'Asia/Seoul');

A DndTimeWindow only accepts time ranges within a single day, where startHour:startMin must be strictly before endHour:endMin. To create a DND window that spans midnight, you need to manually split it into two separate day entries.

For example, Monday 22:00 to Tuesday 07:00 should be split into Monday 22:00–23:59 and Tuesday 00:00–07:00.

Retrieve the current weekly Do Not Disturb configuration for the user.

const preference = await sb.getWeeklyDoNotDisturb();
console.log(preference.doNotDisturbOn); // true
console.log(preference.timezone);       // 'Asia/Seoul'
console.log(preference.dndSchedules);

Remove all weekly Do Not Disturb schedules for the user.

await sb.clearWeeklyDoNotDisturb();

To snooze notification messages for a specific period of time, use the snooze feature.

Note: Snooze can also be set for a user with the Platform API's update push preferences action.

await sb.setSnoozePeriod(true, START_TS, END_TS);