mirror of
https://github.com/zhigang1992/react-native-notifications.git
synced 2026-06-15 10:28:11 +08:00
* Add typescript support * Add unit tests * Splits requestPermissionsWithCategories to two functions * Done converting the js part to typescript * typescript WIP * Fix unit * Fix e2e * Identical API for Android and iOS * Fix bundle * build typescript before test-e2e-ios * build typescript before test-e2e-ios * Add docousaurus documentation * Fix rebase from master * Move android and ios folders into lib folder * Split Notification.ts, Fix android example module * Add test coverage for Notification.ts, clean old js files * Updated docs * Move ios and android commands to designated classes * Remove package.json unused packages * Fix e2e * Fix docs, remove circleci config file * 3.0.0-alpha.0 * Update README.md * Fix js tests * Add missing flavors * Update release script * Add pretest scripts * Update release script * Revert manual version change * Fix release build * Gradle resolve react-native version flavor * Fix documentation website * Add identical registerRemoteNotifications api for iOS and Android * Finish API documentation * Merge from master branch * Fix build * Remove NOTIFICATION_RECEIVED_FOREGROUND_EVENT_NAME * Fix iOS example project * Split specific iOS events, Update docs * Add subscription documentation guide * Add Local Notifications documentation guide * Fix handling actions, Add event handling documentation guide * Fix platforms logo * Fix iOS unit tests * Update package.json version to 3.0.0-beta.0 and generate CHANGELOG.gren.md [ci skip] * Fix documentation * Add prerelease script * Update package.json version to 3.0.0-beta.1 and generate CHANGELOG.gren.md [ci skip] * Add npm run docusaurus * Add removeAllDeliveredNotifications support for both iOS and Android * Add CI tag support * Fix podspec * Update iOS installation * Fix android installation * fix build.gradle rn package.json path * Fix iOS * Add NotificationFactory * Fix tests * Fix resolving gradle react native version * find rn package.json by checking if the file exists instead of an exception in JsonSlurper * Fix e2e * Update package.json version to 3.0.0-beta.2 and generate CHANGELOG.gren.md [ci skip] * Rename setBadgesCount to setBadgeCount * add ios and android Notifications object getters * Update package.json version to 3.0.0-beta.3 and generate CHANGELOG.gren.md [ci skip] * Fix android token registration * Update package.json version to 3.0.0-beta.4 and generate CHANGELOG.gren.md [ci skip] Co-authored-by: wixmobile <41264282+wixmobile@users.noreply.github.com> Co-authored-by: Artal Druk <artald@wix.com>
56 lines
1.5 KiB
Markdown
Executable File
56 lines
1.5 KiB
Markdown
Executable File
---
|
|
id: general-api
|
|
title: General Commands
|
|
sidebar_label: General
|
|
---
|
|
|
|
## registerRemoteNotifications()
|
|
Requests remote notification permissions, prompting the user's dialog box on iOS and request a token on Android.
|
|
If the user accept the remote notifications permissions, `RemoteNotificationsRegistered` event will get called with the device token.
|
|
|
|
```js
|
|
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](notification-object). Otherwise, it resolves to undefined.
|
|
|
|
```js
|
|
const notification: Notification = await Notifications.getInitialNotification();
|
|
```
|
|
|
|
## postLocalNotification(notification, id?)
|
|
Posts local notification to the device notification center.
|
|
|
|
```js
|
|
Notifications.postLocalNotification({
|
|
body: 'Local notificiation!',
|
|
title: 'Local Notification Title',
|
|
sound: 'chime.aiff',
|
|
category: 'SOME_CATEGORY',
|
|
link: 'localNotificationLink',
|
|
fireDate: new Date()
|
|
}, id);
|
|
```
|
|
|
|
## cancelLocalNotification(id)
|
|
Relevant for notifications sent with `fireDate`.
|
|
|
|
```js
|
|
Notifications.cancelLocalNotification(id);
|
|
```
|
|
|
|
## isRegisteredForRemoteNotifications()
|
|
Check if the app has permissions to send remote notifications.
|
|
|
|
```js
|
|
const hasPermissions: boolean = await Notifications.isRegisteredForRemoteNotifications();
|
|
```
|
|
|
|
## removeAllDeliveredNotifications()
|
|
Remove all delivered notifications from Notification Center
|
|
|
|
```js
|
|
Notifications.removeAllDeliveredNotifications();
|
|
```
|