Rich notifications

Send helpers

Needs native-notify v5.2 or later (npm install native-notify@^5.2.0). See Upgrading to v5.

All four take the same options. They pass Expo's message fields through to the messages Native Notify delivers through Expo, and the REST endpoints and Native Notify's send form accept the same fields.

Send a rich notification

import {
  sendMassNotification,
  sendIndieNotification,
  sendIndieGroupNotification,
  sendNotificationToFollowers,
} from 'native-notify';

// Every registered device (mass):
await sendMassNotification('Service update', 'We are back online.', {
  pushData: { url: '/status' },
  subtitle: 'All systems normal',
  channelId: 'alerts',          // Android channel — create it first (below)
  interruptionLevel: 'active',  // iOS
  sound: 'chime.wav',
});

// One subscriber (indie):
await sendIndieNotification(userId, 'Your order', 'It shipped!', {
  pushData: { url: '/orders/' + orderId },
  badge: 1,
  categoryId: 'ORDER_UPDATE',
});

// A custom audience, or the followers of a follow-master:
await sendIndieGroupNotification(subIds, 'Group news', 'Hello all', { channelId: 'news' });
await sendNotificationToFollowers(masterSubId, 'New post', 'Read it', { mutableContent: true });

Each helper resolves with the server's response body:

Options

• Only the options you pass are sent, and the server validates them up front: an invalid value (an unknown interruptionLevel, a non-boolean mutableContent) fails with 400, not per recipient at Expo. sound: false, badge: 0 and contentAvailable: false are real values, not omissions.
• Raw REST calls also accept expiration, a unix timestamp, as an alternative to ttl.
• The fields apply however a device is reached. If an app saved its own FCM v1 service account or APNs key in Native Notify, its devices are delivered directly through FCM and APNs and the fields travel in those payloads: sound, badge, subtitle, ttl and the rest on iOS, high priority and the data fields on Android.
• Mass and single-indie sends carry the hidden notification id that Sessions & push opens reports on. Enable it with analytics: { opens: true }, with your ids set in NativeNotify.init() or passed to registerNNPushToken.

Android notification channels

A channelId has to match a channel the app has created on the device. setAndroidNotificationChannel(channelId, options) wraps expo-notifications' setNotificationChannelAsync(), so create the channel before you send to it:

import * as Notifications from 'expo-notifications';
import { setAndroidNotificationChannel, sendMassNotification } from 'native-notify';

await setAndroidNotificationChannel('alerts', {
  name: 'Alerts',
  importance: Notifications.AndroidImportance.HIGH,
  sound: 'chime.wav',
  vibrationPattern: [0, 250, 250, 250],
});

// Then send to it:
await sendMassNotification('Heads up', 'The service is back', { channelId: 'alerts' });

Only the keys you set are used:

It resolves true on Android. On iOS and the web, or when the call fails, it resolves false and never throws, so callers keep their default channel.