expo-notifications
Version:
Provides an API to fetch push notification tokens and to present, schedule, receive, and respond to notifications.
42 lines (41 loc) • 1.54 kB
TypeScript
import { ConfigPlugin } from 'expo/config-plugins';
export type NotificationsPluginProps = {
/**
* Local path to an image to use as the icon for push notifications.
* 96x96 all-white png with transparency. We recommend following
* [Google's design guidelines](https://material.io/design/iconography/product-icons.html#design-principles).
* @platform android
*/
icon?: string;
/**
* Tint color for the push notification image when it appears in the notification tray.
* @default '#ffffff'
* @platform android
*/
color?: string;
/**
* Default channel for FCMv1 notifications.
* @platform android
*/
defaultChannel?: string;
/**
* Array of local paths to sound files (.wav recommended) that can be used as custom notification sounds.
*/
sounds?: string[];
/**
* Environment of the app: either 'development' or 'production'.
* @default 'development'
* @platform ios
*/
mode?: 'development' | 'production';
/**
* Whether to enable background remote notifications, as described in [Apple documentation](https://developer.apple.com/documentation/usernotifications/pushing-background-updates-to-your-app).
*
* This sets the `UIBackgroundModes` key in the `Info.plist` to include `remote-notification`.
* @default false
* @platform ios
*/
enableBackgroundRemoteNotifications?: boolean;
};
declare const _default: ConfigPlugin<void | NotificationsPluginProps>;
export default _default;