expo-notifications
Version:
Provides an API to fetch push notification tokens and to present, schedule, receive, and respond to notifications.
47 lines • 2.06 kB
JavaScript
import { Platform } from 'expo-modules-core';
import PushTokenManager from './PushTokenManager';
import { warnOfExpoGoPushUsage } from './warnOfExpoGoPushUsage';
// Web uses SyntheticEventEmitter
const newTokenEventName = 'onDevicePushToken';
/**
* In rare situations, a push token may be changed by the push notification service while the app is running.
* When a token is rolled, the old one becomes invalid and sending notifications to it will fail.
* A push token listener will let you handle this situation gracefully by registering the new token with your backend right away.
* @param listener A function accepting a push token as an argument, it will be called whenever the push token changes.
* @return An [`EventSubscription`](#eventsubscription) object represents the subscription of the provided listener.
* @header fetch
* @example Registering a push token listener using a React hook.
* ```jsx
* import React from 'react';
* import * as Notifications from 'expo-notifications';
*
* import { registerDevicePushTokenAsync } from '../api';
*
* export default function App() {
* React.useEffect(() => {
* const subscription = Notifications.addPushTokenListener(registerDevicePushTokenAsync);
* return () => subscription.remove();
* }, []);
*
* return (
* // Your app content
* );
* }
* ```
*/
export function addPushTokenListener(listener) {
warnOfExpoGoPushUsage();
return PushTokenManager.addListener(newTokenEventName, ({ devicePushToken }) => listener({ data: devicePushToken, type: Platform.OS }));
}
/**
* @deprecated call `remove()` on the subscription object instead.
*
* Removes a push token subscription returned by an `addPushTokenListener` call.
* @param subscription A subscription returned by `addPushTokenListener` method.
* @header fetch
*/
export function removePushTokenSubscription(subscription) {
console.warn('`removePushTokenSubscription` is deprecated. Call `subscription.remove()` instead.');
subscription.remove();
}
//# sourceMappingURL=TokenEmitter.js.map