General Commands

registerRemoteNotifications(options?)

Requests remote notification permissions, prompting the user's dialog box on iOS and request a token on Android. See iOS specific registerRemoteNotifications for definition of options. If the user accept the remote notifications permissions, registerRemoteNotificationsRegistered event will get called with the device token.

Notifications.registerRemoteNotifications();

getInitialNotification()

This method returns a promise. If the app was launched by a push notification, this promise resolves to an object of type Notification. Otherwise, it resolves to undefined.

const notification: Notification = await Notifications.getInitialNotification();

postLocalNotification(notification, id?)

Posts local notification to the device notification center.

Notifications.postLocalNotification({

body: 'Local notification!',

title: 'Local Notification Title',

sound: 'chime.aiff',

category: 'SOME_CATEGORY',

link: 'localNotificationLink',

fireDate: new Date() // only iOS

}, id);

cancelLocalNotification(id)

Only iOS. Relevant for notifications sent with fireDate.

Notifications.cancelLocalNotification(id);

isRegisteredForRemoteNotifications()

Check if the app has permissions to send remote notifications.

const hasPermissions: boolean = await Notifications.isRegisteredForRemoteNotifications();

removeAllDeliveredNotifications()

Remove all delivered notifications from Notification Center

Notifications.removeAllDeliveredNotifications();