Repository: react-native-community/react-native-push-notification-ios Branch: master Commit: 84a3dd1aa417 Files: 89 Total size: 244.9 KB Directory structure: gitextract_8izfo38i/ ├── .buckconfig ├── .eslintignore ├── .eslintrc.js ├── .flowconfig ├── .gitattributes ├── .github/ │ └── workflows/ │ └── ci.yml ├── .gitignore ├── .prettierrc.js ├── .watchmanconfig ├── .yarnclean ├── LICENSE ├── README.md ├── RNCPushNotificationIOS.podspec ├── android/ │ ├── app/ │ │ ├── BUCK │ │ ├── build.gradle │ │ ├── build_defs.bzl │ │ ├── proguard-rules.pro │ │ └── src/ │ │ └── main/ │ │ ├── AndroidManifest.xml │ │ ├── java/ │ │ │ └── com/ │ │ │ └── pushnotificationios/ │ │ │ ├── MainActivity.java │ │ │ └── MainApplication.java │ │ └── res/ │ │ └── values/ │ │ ├── strings.xml │ │ └── styles.xml │ ├── build.gradle │ ├── gradle/ │ │ └── wrapper/ │ │ ├── gradle-wrapper.jar │ │ └── gradle-wrapper.properties │ ├── gradle.properties │ ├── gradlew │ ├── gradlew.bat │ ├── keystores/ │ │ ├── BUCK │ │ └── debug.keystore.properties │ └── settings.gradle ├── babel.config.js ├── docs/ │ └── manual-linking.md ├── example/ │ ├── .gitattributes │ ├── .gitignore │ ├── .watchmanconfig │ ├── App.js │ ├── android/ │ │ ├── app/ │ │ │ ├── _BUCK │ │ │ ├── build.gradle │ │ │ ├── build_defs.bzl │ │ │ ├── debug.keystore │ │ │ ├── proguard-rules.pro │ │ │ └── src/ │ │ │ ├── debug/ │ │ │ │ ├── AndroidManifest.xml │ │ │ │ └── java/ │ │ │ │ └── com/ │ │ │ │ └── example/ │ │ │ │ └── ReactNativeFlipper.java │ │ │ └── main/ │ │ │ ├── AndroidManifest.xml │ │ │ ├── java/ │ │ │ │ └── com/ │ │ │ │ └── example/ │ │ │ │ ├── MainActivity.java │ │ │ │ └── MainApplication.java │ │ │ └── res/ │ │ │ └── values/ │ │ │ ├── strings.xml │ │ │ └── styles.xml │ │ ├── build.gradle │ │ ├── gradle/ │ │ │ └── wrapper/ │ │ │ ├── gradle-wrapper.jar │ │ │ └── gradle-wrapper.properties │ │ ├── gradle.properties │ │ ├── gradlew │ │ ├── gradlew.bat │ │ └── settings.gradle │ ├── app.json │ ├── babel.config.js │ ├── ios/ │ │ ├── Podfile │ │ ├── example/ │ │ │ ├── AppDelegate.h │ │ │ ├── AppDelegate.m │ │ │ ├── Images.xcassets/ │ │ │ │ ├── AppIcon.appiconset/ │ │ │ │ │ └── Contents.json │ │ │ │ └── Contents.json │ │ │ ├── Info.plist │ │ │ ├── LaunchScreen.storyboard │ │ │ ├── example.entitlements │ │ │ ├── exampleDebug.entitlements │ │ │ ├── exampleRelease.entitlements │ │ │ └── main.m │ │ ├── example.xcodeproj/ │ │ │ ├── project.pbxproj │ │ │ └── xcshareddata/ │ │ │ └── xcschemes/ │ │ │ └── example.xcscheme │ │ ├── example.xcworkspace/ │ │ │ ├── contents.xcworkspacedata │ │ │ └── xcshareddata/ │ │ │ └── IDEWorkspaceChecks.plist │ │ └── exampleTests/ │ │ ├── Info.plist │ │ └── exampleTests.m │ └── metro.config.js ├── index.d.ts ├── index.js ├── ios/ │ ├── PushNotificationIOS.xcodeproj/ │ │ ├── project.pbxproj │ │ └── xcshareddata/ │ │ └── xcschemes/ │ │ ├── PushNotificationIOS-tvOS.xcscheme │ │ └── PushNotificationIOS.xcscheme │ ├── RCTConvert+Notification.h │ ├── RCTConvert+Notification.m │ ├── RNCPushNotificationIOS.h │ └── RNCPushNotificationIOS.m ├── js/ │ ├── index.js │ └── types.js ├── package.json └── tsconfig.json ================================================ FILE CONTENTS ================================================ ================================================ FILE: .buckconfig ================================================ [android] target = Google Inc.:Google APIs:23 [maven_repositories] central = https://repo1.maven.org/maven2 ================================================ FILE: .eslintignore ================================================ node_modules ================================================ FILE: .eslintrc.js ================================================ module.exports = { root: true, extends: ["@react-native-community"] }; ================================================ FILE: .flowconfig ================================================ [ignore] ; We fork some components by platform .*/*[.]android.js ; Ignore "BUCK" generated dirs /\.buckd/ ; Ignore polyfills node_modules/react-native/Libraries/polyfills/.* ; These should not be required directly ; require from fbjs/lib instead: require('fbjs/lib/warning') node_modules/warning/.* ; Flow doesn't support platforms .*/Libraries/Utilities/LoadingView.js [untyped] .*/node_modules/@react-native-community/cli/.*/.* [include] [libs] node_modules/react-native/interface.js node_modules/react-native/flow/ [options] emoji=true esproposal.optional_chaining=enable esproposal.nullish_coalescing=enable module.file_ext=.js module.file_ext=.json module.file_ext=.ios.js munge_underscores=true module.name_mapper='^react-native/\(.*\)$' -> '/node_modules/react-native/\1' module.name_mapper='^@?[./a-zA-Z0-9$_-]+\.\(bmp\|gif\|jpg\|jpeg\|png\|psd\|svg\|webp\|m4v\|mov\|mp4\|mpeg\|mpg\|webm\|aac\|aiff\|caf\|m4a\|mp3\|wav\|html\|pdf\)$' -> '/node_modules/react-native/Libraries/Image/RelativeImageStub' suppress_type=$FlowIssue suppress_type=$FlowFixMe suppress_type=$FlowFixMeProps suppress_type=$FlowFixMeState [lints] sketchy-null-number=warn sketchy-null-mixed=warn sketchy-number=warn untyped-type-import=warn nonstrict-import=warn deprecated-type=warn unsafe-getters-setters=warn unnecessary-invariant=warn signature-verification-failure=warn deprecated-utility=error [strict] deprecated-type nonstrict-import sketchy-null unclear-type unsafe-getters-setters untyped-import untyped-type-import [version] ^0.137.0 ================================================ FILE: .gitattributes ================================================ *.pbxproj -text # specific for windows script files *.bat text eol=crlf ================================================ FILE: .github/workflows/ci.yml ================================================ name: Build on: push jobs: lint: runs-on: ubuntu-latest strategy: matrix: node-version: [16] steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - name: Get yarn cache id: yarn-cache run: echo "::set-output name=dir::$(yarn cache dir)" - uses: actions/cache@v2 with: path: ${{ steps.yarn-cache.outputs.dir }} key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - name: Install Dependencies run: yarn - name: ESLint Checks run: yarn lint tsc: runs-on: ubuntu-latest strategy: matrix: node-version: [16] steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - name: Get yarn cache id: yarn-cache run: echo "::set-output name=dir::$(yarn cache dir)" - uses: actions/cache@v2 with: path: ${{ steps.yarn-cache.outputs.dir }} key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - name: Install Dependencies run: yarn - name: TypeScript type check run: yarn test:tsc flow: runs-on: ubuntu-latest strategy: matrix: node-version: [16] steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - name: Get yarn cache id: yarn-cache run: echo "::set-output name=dir::$(yarn cache dir)" - uses: actions/cache@v2 with: path: ${{ steps.yarn-cache.outputs.dir }} key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - name: Install Dependencies run: yarn - name: TypeScript type check run: yarn test:flow ios: runs-on: macos-latest strategy: matrix: node-version: [16] steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - name: Get yarn cache id: yarn-cache run: echo "::set-output name=dir::$(yarn cache dir)" - uses: actions/cache@v2 with: path: ${{ steps.yarn-cache.outputs.dir }} key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - name: Install Dependencies run: yarn - name: Install Podfiles run: cd example && npx pod-install - name: Build example app run: yarn ios ================================================ FILE: .gitignore ================================================ # OSX # .DS_Store # node.js # node_modules/ npm-debug.log yarn-error.log # Xcode # build/ *.pbxuser !default.pbxuser *.mode1v3 !default.mode1v3 *.mode2v3 !default.mode2v3 *.perspectivev3 !default.perspectivev3 xcuserdata *.xccheckout *.moved-aside DerivedData *.hmap *.ipa *.xcuserstate project.xcworkspace # Android/IntelliJ # build/ .idea .gradle local.properties *.iml # BUCK buck-out/ \.buckd/ *.keystore # Editor config .vscode # eslintcache .eslintcache ================================================ FILE: .prettierrc.js ================================================ module.exports = { bracketSpacing: false, jsxBracketSameLine: true, singleQuote: true, trailingComma: 'all', }; ================================================ FILE: .watchmanconfig ================================================ {} ================================================ FILE: .yarnclean ================================================ # test directories __tests__ test tests powered-test # asset directories docs doc website images # examples example examples # code coverage directories coverage .nyc_output # build scripts Makefile Gulpfile.js Gruntfile.js # configs appveyor.yml circle.yml codeship-services.yml codeship-steps.yml wercker.yml .tern-project .gitattributes .editorconfig .*ignore .eslintrc .jshintrc .flowconfig .documentup.json .yarn-metadata.json .travis.yml # misc *.md ================================================ FILE: LICENSE ================================================ MIT License Copyright (c) 2020 react-native-community Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.% ================================================ FILE: README.md ================================================ # @react-native-community/push-notification-ios [![Build Status][build-badge]][build] [![Version][version-badge]][package] [![MIT License][license-badge]][license] [![Lean Core Badge][lean-core-badge]][lean-core-issue] React Native Push Notification API for iOS. | Notification | With Action | With TextInput Action | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | | | | ## Getting started ### Install Using npm: ```bash npm i @react-native-community/push-notification-ios --save ``` or using Yarn: ```bash yarn add @react-native-community/push-notification-ios ``` ## Link ### React Native v0.60+ The package is [automatically linked](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) when building the app. All you need to do is: ```bash npx pod-install ``` For android, the package will be linked automatically on build.
For React Native version 0.59 or older ### React Native <= v0.59 ```bash react-native link @react-native-community/push-notification-ios ``` - upgrading to `react-native >= 0.60` First, unlink the library. Then follow the instructions above. ```bash react-native unlink @react-native-community/push-notification-ios ``` - manual linking If you don't want to use the methods above, you can always [link the library manually](./docs/manual-linking.md).
### Add Capabilities : Background Mode - Remote Notifications Go into your MyReactProject/ios dir and open MyProject.xcworkspace workspace. Select the top project "MyProject" and select the "Signing & Capabilities" tab. Add a 2 new Capabilities using "+" button: - `Background Mode` capability and tick `Remote Notifications`. - `Push Notifications` capability ### Augment `AppDelegate` Finally, to enable support for `notification` and `register` events you need to augment your AppDelegate. ### Update `AppDelegate.h` At the top of the file: ```objective-c #import ``` Then, add the 'UNUserNotificationCenterDelegate' to protocols: For RN v0.71 and above ```objective-c @interface AppDelegate : RCTAppDelegate ``` For RN v0.70 and below ```objective-c @interface AppDelegate : UIResponder ``` ### Update `AppDelegate.m` or `AppDelegate.mm` At the top of the file: ```objective-c #import #import ``` Then, in your AppDelegate implementation, add the following: ```objective-c // Required for the register event. - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { [RNCPushNotificationIOS didRegisterForRemoteNotificationsWithDeviceToken:deviceToken]; } // Required for the notification event. You must call the completion handler after handling the remote notification. - (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler { [RNCPushNotificationIOS didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler]; } // Required for the registrationError event. - (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error { [RNCPushNotificationIOS didFailToRegisterForRemoteNotificationsWithError:error]; } // Required for localNotification event - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler { [RNCPushNotificationIOS didReceiveNotificationResponse:response]; } ``` And then add the following lines: ```objective-c - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { ... // Define UNUserNotificationCenter UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; center.delegate = self; return YES; } //Called when a notification is delivered to a foreground app. -(void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler { completionHandler(UNNotificationPresentationOptionSound | UNNotificationPresentationOptionAlert | UNNotificationPresentationOptionBadge); } ``` ## Migrating from the core `react-native` module This module was created when the PushNotificationIOS was split out from the core of React Native. To migrate to this module you need to follow the installation instructions above and then change you imports from: ```js import {PushNotificationIOS} from 'react-native'; ``` to: ```js import PushNotificationIOS from '@react-native-community/push-notification-ios'; ``` ## How to determine push notification user click Receiving remote pushes has two common cases: user dismissed notification and user clicked notification. To have separate logic for each case you can use `notification.getData().userInteraction` to determine push notification user click: ```js export const App = () => { const [permissions, setPermissions] = useState({}); useEffect(() => { const type = 'notification'; PushNotificationIOS.addEventListener(type, onRemoteNotification); return () => { PushNotificationIOS.removeEventListener(type); }; }); const onRemoteNotification = (notification) => { const isClicked = notification.getData().userInteraction === 1; if (isClicked) { // Navigate user to another screen } else { // Do something else with push notification } // Use the appropriate result based on what you needed to do for this notification const result = PushNotificationIOS.FetchResult.NoData; notification.finish(result); }; }; ``` ## How to perform different action based on user selected action. ```js export const App = () => { const [permissions, setPermissions] = useState({}); /** * By calling this function, notification with category `userAction` will have action buttons */ const setNotificationCategories = () => { PushNotificationIOS.setNotificationCategories([ { id: 'userAction', actions: [ {id: 'open', title: 'Open', options: {foreground: true}}, { id: 'ignore', title: 'Desruptive', options: {foreground: true, destructive: true}, }, { id: 'text', title: 'Text Input', options: {foreground: true}, textInput: {buttonTitle: 'Send'}, }, ], }, ]); }; useEffect(() => { const type = 'notification'; PushNotificationIOS.addEventListener(type, onRemoteNotification); return () => { PushNotificationIOS.removeEventListener(type); }; }); const onRemoteNotification = (notification) => { const actionIdentifier = notification.getActionIdentifier(); if (actionIdentifier === 'open') { // Perform action based on open action } if (actionIdentifier === 'text') { // Text that of user input. const userText = notification.getUserText(); // Perform action based on textinput action } // Use the appropriate result based on what you needed to do for this notification const result = PushNotificationIOS.FetchResult.NoData; notification.finish(result); }; }; ``` ## How to receive rich notification in remote Follow this [article](https://firebase.google.com/docs/cloud-messaging/ios/send-image) to create rich notification of your own # Reference ## Methods ### `presentLocalNotification()` ```jsx PushNotificationIOS.presentLocalNotification(details); ``` _Deprecated_ - use `addNotificationRequest` instead. Schedules the localNotification for immediate presentation. **Parameters:** | Name | Type | Required | Description | | ------- | ------ | -------- | ----------- | | details | object | Yes | See below. | details is an object containing: - `alertBody` : The message displayed in the notification alert. - `alertAction` : The "action" displayed beneath an actionable notification. Defaults to "view". Note that Apple no longer shows this in iOS 10 + - `alertTitle` : The text displayed as the title of the notification alert. - `soundName` : The sound played when the notification is fired (optional). - `isSilent` : If true, the notification will appear without sound (optional). - `category` : The category of this notification, required for actionable notifications (optional). - `userInfo` : An object containing additional notification data (optional). - `applicationIconBadgeNumber` The number to display as the app's icon badge. The default value of this property is 0, which means that no badge is displayed (optional). --- ### `scheduleLocalNotification()` ```jsx PushNotificationIOS.scheduleLocalNotification(details); ``` _Deprecated_ - use `addNotificationRequest` instead. Schedules the localNotification for future presentation. **Parameters:** | Name | Type | Required | Description | | ------- | ------ | -------- | ----------- | | details | object | Yes | See below. | details is an object containing: - `fireDate` : The date and time when the system should deliver the notification. - `alertTitle` : The text displayed as the title of the notification alert. - `alertBody` : The message displayed in the notification alert. - `alertAction` : The "action" displayed beneath an actionable notification. Defaults to "view". Note that Apple no longer shows this in iOS 10 + - `soundName` : The sound played when the notification is fired (optional). - `isSilent` : If true, the notification will appear without sound (optional). - `category` : The category of this notification, required for actionable notifications (optional). - `userInfo` : An object containing additional notification data (optional). - `image` : It's useful if you need to diplay rich notification (optional). - `applicationIconBadgeNumber` The number to display as the app's icon badge. Setting the number to 0 removes the icon badge (optional). - `repeatInterval` : The interval to repeat as a string. Possible values: `minute`, `hour`, `day`, `week`, `month`, `year` (optional). --- ### `addNotificationRequest()` ```jsx PushNotificationIOS.addNotificationRequest(request); ``` Sends notificationRequest to notification center at specified firedate. Fires immediately if firedate is not set. **Parameters:** | Name | Type | Required | Description | | ------- | ------ | -------- | ----------- | | request | object | Yes | See below. | request is an object containing: - `id`: Identifier of the notification. Required in order to be able to retrieve specific notification. (required) - `title`: A short description of the reason for the alert. - `subtitle`: A secondary description of the reason for the alert. - `body` : The message displayed in the notification alert. - `badge` The number to display as the app's icon badge. Setting the number to 0 removes the icon badge. - `fireDate` : The date and time when the system should deliver the notification. - `repeats` : Sets notification to repeat. Must be used with fireDate and repeatsComponent. - `repeatsComponent`: An object indicating which parts of fireDate should be repeated. - `sound` : The sound played when the notification is fired. - `category` : The category of this notification, required for actionable notifications. - `isSilent` : If true, the notification will appear without sound. - `isCritical` : If true, the notification sound be played even when the device is locked, muted, or has Do Not Disturb enabled. - `criticalSoundVolume` : A number between 0 and 1 for volume of critical notification. Default volume will be used if not specified. - `userInfo` : An object containing additional notification data. - `isTimeZoneAgnostic` : If true, fireDate adjusted automatically upon time zone changes (e.g. for an alarm clock). - `interruptionLevel` (iOS15+): A string specifying the interruption level. Valid values are `'active'`, `'passive'`, `'timeSensitive'`, or `'critical'` request.repeatsComponent is an object containing (each field is optional): - `year`: Will repeat every selected year in your fireDate. - `month`: Will repeat every selected month in your fireDate. - `day`: Will repeat every selected day in your fireDate. - `dayOfWeek`: Will repeat every selected day of the week in your fireDate. - `hour`: Will repeat every selected hour in your fireDate. - `minute`: Will repeat every selected minute in your fireDate. - `second`: Will repeat every selected second in your fireDate. For example, let’s say you want to have a notification repeating every day at 23:54, starting tomorrow, you will use something like this: ```javascript const getCorrectDate = () => { const date = new Date(); date.setDate(date.getDate() + 1); date.setHours(23); date.setMinutes(54); return date; }; PushNotificationIOS.addNotificationRequest({ fireDate: getCorrectDate(), repeats: true, repeatsComponent: { hour: true, minute: true, }, }); ``` If you want to repeat every time the clock reach 54 minutes (like 00:54, 01:54, and so on), just switch hour to false. Every field is used to indicate at what time the notification should be repeated, exactly like you could do on iOS. --- ### `setNotificationCategories()` ```jsx PushNotificationIOS.setNotificationCategories(categories); ``` Sets category for the notification center. Allows you to add specific actions for notification with specific category. **Parameters:** | Name | Type | Required | Description | | ---------- | -------- | -------- | ----------- | | categories | object[] | Yes | See below. | `category` is an object containing: - `id`: Identifier of the notification category. Notification with this category will have the specified actions. (required) - `actions`: An array of notification actions to be attached to the notification of category id. `action` is an object containing: - `id`: Identifier of Action. This value will be returned as actionIdentifier when notification is received. - `title`: Text to be shown on notification action button. - `options`: Options for notification action. - `foreground`: If `true`, action will be displayed on notification. - `destructive`: If `true`, action will be displayed as destructive notification. - `authenticationRequired`: If `true`, action will only be displayed for authenticated user. - `textInput`: Option for textInput action. If textInput prop exists, then user action will automatically become a text input action. The text user inputs will be in the userText field of the received notification. - `buttonTitle`: Text to be shown on button when user finishes text input. Default is "Send" or its equivalent word in user's language setting. - `placeholder`: Placeholder for text input for text input action. --- ### `removePendingNotificationRequests()` ```jsx PushNotificationIOS.removePendingNotificationRequests(identifiers); ``` Removes the specified pending notifications from Notification Center **Parameters:** | Name | Type | Required | Description | | ----------- | -------- | -------- | ---------------------------------- | | identifiers | string[] | Yes | Array of notification identifiers. | --- ### `removeAllPendingNotificationRequests()` ```jsx PushNotificationIOS.removeAllPendingNotificationRequests(); ``` Removes all pending notification requests in the notification center. --- ### `removeAllDeliveredNotifications()` ```jsx PushNotificationIOS.removeAllDeliveredNotifications(); ``` Remove all delivered notifications from Notification Center --- ### `getDeliveredNotifications()` ```jsx PushNotificationIOS.getDeliveredNotifications(callback); ``` Provides you with a list of the app’s notifications that are still displayed in Notification Center **Parameters:** | Name | Type | Required | Description | | -------- | -------- | -------- | ----------------------------------------------------------- | | callback | function | Yes | Function which receive an array of delivered notifications. | A delivered notification is an object containing: - `identifier` : The identifier of this notification. - `title` : The title of this notification. - `body` : The body of this notification. - `category` : The category of this notification (optional). - `userInfo` : An object containing additional notification data (optional). - `thread-id` : The thread identifier of this notification, if has one. --- ### `removeDeliveredNotifications()` ```jsx PushNotificationIOS.removeDeliveredNotifications(identifiers); ``` Removes the specified delivered notifications from Notification Center **Parameters:** | Name | Type | Required | Description | | ----------- | -------- | -------- | ---------------------------------- | | identifiers | string[] | Yes | Array of notification identifiers. | --- ### `setApplicationIconBadgeNumber()` ```jsx PushNotificationIOS.setApplicationIconBadgeNumber(number); ``` Sets the badge number for the app icon on the home screen **Parameters:** | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------ | | number | number | Yes | Badge number for the app icon. | --- ### `getApplicationIconBadgeNumber()` ```jsx PushNotificationIOS.getApplicationIconBadgeNumber(callback); ``` Gets the current badge number for the app icon on the home screen **Parameters:** | Name | Type | Required | Description | | -------- | -------- | -------- | -------------------------------------------------------- | | callback | function | Yes | A function that will be passed the current badge number. | --- ### `cancelLocalNotifications()` ```jsx PushNotificationIOS.cancelLocalNotifications(userInfo); ``` Cancel local notifications. Optionally restricts the set of canceled notifications to those notifications whose `userInfo` fields match the corresponding fields in the `userInfo` argument. **Parameters:** | Name | Type | Required | Description | | -------- | ------ | -------- | ----------- | | userInfo | object | No | | --- ### `getScheduledLocalNotifications()` ```jsx PushNotificationIOS.getScheduledLocalNotifications(callback); ``` Gets the local notifications that are currently scheduled. **Parameters:** | Name | Type | Required | Description | | -------- | -------- | -------- | ---------------------------------------------------------------------------------- | | callback | function | Yes | A function that will be passed an array of objects describing local notifications. | --- ### `addEventListener()` ```jsx PushNotificationIOS.addEventListener(type, handler); ``` Attaches a listener to remote or local notification events while the app is running in the foreground or the background. **Parameters:** | Name | Type | Required | Description | | ------- | -------- | -------- | ----------- | | type | string | Yes | Event type. | | handler | function | Yes | Listener. | Valid events are: - `notification` : Fired when a remote notification is received. The handler will be invoked with an instance of `PushNotificationIOS`. - `localNotification` : Fired when a local notification is received. The handler will be invoked with an instance of `PushNotificationIOS`. - `register`: Fired when the user registers for remote notifications. The handler will be invoked with a hex string representing the deviceToken. - `registrationError`: Fired when the user fails to register for remote notifications. Typically occurs when APNS is having issues, or the device is a simulator. The handler will be invoked with {message: string, code: number, details: any}. --- ### `removeEventListener()` ```jsx PushNotificationIOS.removeEventListener(type); ``` Removes the event listener. Do this in `componentWillUnmount` to prevent memory leaks **Parameters:** | Name | Type | Required | Description | | ---- | ------ | -------- | ----------- | | type | string | Yes | Event type. | --- ### `requestPermissions()` ```jsx PushNotificationIOS.requestPermissions([permissions]); ``` Requests notification permissions from iOS, prompting the user's dialog box. By default, it will request all notification permissions, but a subset of these can be requested by passing a map of requested permissions. The following permissions are supported: - `alert` - `badge` - `sound` - `critical` `critical` requires special entitlement that could be requested here: https://developer.apple.com/contact/request/notifications-critical-alerts-entitlement/ If a map is provided to the method, only the permissions with truthy values will be requested. This method returns a promise that will resolve when the user accepts, rejects, or if the permissions were previously rejected. The promise resolves to the current state of the permission. **Parameters:** | Name | Type | Required | Description | | ----------- | ----- | -------- | ------------------------------- | | permissions | array | No | alert, badge, sound or critical | --- ### `abandonPermissions()` ```jsx PushNotificationIOS.abandonPermissions(); ``` Unregister for all remote notifications received via Apple Push Notification service. You should call this method in rare circumstances only, such as when a new version of the app removes support for all types of remote notifications. Users can temporarily prevent apps from receiving remote notifications through the Notifications section of the Settings app. Apps unregistered through this method can always re-register. --- ### `checkPermissions()` ```jsx PushNotificationIOS.checkPermissions(callback); ``` See what push permissions are currently enabled. **Parameters:** | Name | Type | Required | Description | | -------- | -------- | -------- | ----------- | | callback | function | Yes | See below. | `callback` will be invoked with a `permissions` object: - `alert` :boolean - `badge` :boolean - `sound` :boolean - `critical` :boolean - `lockScreen` :boolean - `notificationCenter` :boolean - `authorizationStatus` :AuthorizationStatus For a list of possible values of `authorizationStatus`, see `PushNotificationIOS.AuthorizationStatus`. For their meanings, refer to https://developer.apple.com/documentation/usernotifications/unauthorizationstatus --- ### `getInitialNotification()` ```jsx PushNotificationIOS.getInitialNotification(); ``` This method returns a promise. If the app was launched by a push notification, this promise resolves to an object of type `PushNotificationIOS`. Otherwise, it resolves to `null`. --- ### `constructor()` ```jsx constructor(nativeNotif); ``` You will never need to instantiate `PushNotificationIOS` yourself. Listening to the `notification` event and invoking `getInitialNotification` is sufficient. --- ### `finish()` ```jsx finish(fetchResult); ``` This method is available for remote notifications that have been received via: `application:didReceiveRemoteNotification:fetchCompletionHandler:` https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623013-application?language=objc Call this to execute when the remote notification handling is complete. When calling this block, pass in the fetch result value that best describes the results of your operation. You _must_ call this handler and should do so as soon as possible. For a list of possible values, see `PushNotificationIOS.FetchResult`. If you do not call this method your background remote notifications could be throttled, to read more about it see the above documentation link. --- ### `getMessage()` ```jsx getMessage(); ``` An alias for `getAlert` to get the notification's main message string --- ### `getSound()` ```jsx getSound(); ``` Gets the sound string from the `aps` object --- ### `getCategory()` ```jsx getCategory(); ``` Gets the category string from the `aps` object --- ### `getAlert()` ```jsx getAlert(); ``` Gets the notification's main message from the `aps` object --- ### `getTitle()` ```jsx getTitle(); ``` Gets the notification's title from the `aps` object --- ### `getSubtitle()` ```jsx getSubtitle(); ``` Gets the notification's subtitle from the `aps` object --- ### `getContentAvailable()` ```jsx getContentAvailable(); ``` Gets the content-available number from the `aps` object --- ### `getBadgeCount()` ```jsx getBadgeCount(); ``` Gets the badge count number from the `aps` object --- ### `getData()` ```jsx getData(); ``` Gets the data object on the notification --- ### `getThreadID()` ```jsx getThreadID(); ``` Gets the thread ID on the notification [build-badge]: https://github.com/react-native-push-notification-ios/push-notification-ios/workflows/Build/badge.svg [build]: https://github.com/react-native-push-notification-ios/push-notification-ios/actions [version-badge]: https://img.shields.io/npm/v/@react-native-community/push-notification-ios.svg?style=flat-square [package]: https://www.npmjs.com/package/@react-native-community/push-notification-ios [license-badge]: https://img.shields.io/npm/l/@react-native-community/push-notification-ios.svg?style=flat-square [license]: https://opensource.org/licenses/MIT [lean-core-badge]: https://img.shields.io/badge/Lean%20Core-Extracted-brightgreen.svg?style=flat-square [lean-core-issue]: https://github.com/facebook/react-native/issues/23313 ================================================ FILE: RNCPushNotificationIOS.podspec ================================================ require "json" package = JSON.parse(File.read(File.join(File.dirname(__FILE__), "package.json"))) Pod::Spec.new do |s| # NPM package specification s.name = 'RNCPushNotificationIOS' s.version = package['version'] s.summary = package['description'] s.description = package['description'] s.license = package['license'] s.author = package['author'] s.homepage = package['homepage'] s.source = { :git => "https://github.com/react-native-community/push-notification-ios", :tag => "v#{s.version}" } s.source_files = "ios/*.{h,m}" s.platform = :ios, "10.0" s.dependency "React-Core" end ================================================ FILE: android/app/BUCK ================================================ # To learn about Buck see [Docs](https://buckbuild.com/). # To run your application with Buck: # - install Buck # - `npm start` - to start the packager # - `cd android` # - `keytool -genkey -v -keystore keystores/debug.keystore -storepass android -alias androiddebugkey -keypass android -dname "CN=Android Debug,O=Android,C=US"` # - `./gradlew :app:copyDownloadableDepsToLibs` - make all Gradle compile dependencies available to Buck # - `buck install -r android/app` - compile, install and run application # load(":build_defs.bzl", "create_aar_targets", "create_jar_targets") lib_deps = [] create_aar_targets(glob(["libs/*.aar"])) create_jar_targets(glob(["libs/*.jar"])) android_library( name = "all-libs", exported_deps = lib_deps, ) android_library( name = "app-code", srcs = glob([ "src/main/java/**/*.java", ]), deps = [ ":all-libs", ":build_config", ":res", ], ) android_build_config( name = "build_config", package = "com.reactnativecommunity.pushnotificationios", ) android_resource( name = "res", package = "com.reactnativecommunity.pushnotificationios", res = "src/main/res", ) android_binary( name = "app", keystore = "//android/keystores:debug", manifest = "src/main/AndroidManifest.xml", package_type = "debug", deps = [ ":app-code", ], ) ================================================ FILE: android/app/build.gradle ================================================ apply plugin: "com.android.application" import com.android.build.OutputFile /** * The react.gradle file registers a task for each build variant (e.g. bundleDebugJsAndAssets * and bundleReleaseJsAndAssets). * These basically call `react-native bundle` with the correct arguments during the Android build * cycle. By default, bundleDebugJsAndAssets is skipped, as in debug/dev mode we prefer to load the * bundle directly from the development server. Below you can see all the possible configurations * and their defaults. If you decide to add a configuration block, make sure to add it before the * `apply from: "../../node_modules/react-native/react.gradle"` line. * * project.ext.react = [ * // the name of the generated asset file containing your JS bundle * bundleAssetName: "index.android.bundle", * * // the entry file for bundle generation * entryFile: "index.android.js", * * // whether to bundle JS and assets in debug mode * bundleInDebug: false, * * // whether to bundle JS and assets in release mode * bundleInRelease: true, * * // whether to bundle JS and assets in another build variant (if configured). * // See http://tools.android.com/tech-docs/new-build-system/user-guide#TOC-Build-Variants * // The configuration property can be in the following formats * // 'bundleIn${productFlavor}${buildType}' * // 'bundleIn${buildType}' * // bundleInFreeDebug: true, * // bundleInPaidRelease: true, * // bundleInBeta: true, * * // whether to disable dev mode in custom build variants (by default only disabled in release) * // for example: to disable dev mode in the staging build type (if configured) * devDisabledInStaging: true, * // The configuration property can be in the following formats * // 'devDisabledIn${productFlavor}${buildType}' * // 'devDisabledIn${buildType}' * * // the root of your project, i.e. where "package.json" lives * root: "../../", * * // where to put the JS bundle asset in debug mode * jsBundleDirDebug: "$buildDir/intermediates/assets/debug", * * // where to put the JS bundle asset in release mode * jsBundleDirRelease: "$buildDir/intermediates/assets/release", * * // where to put drawable resources / React Native assets, e.g. the ones you use via * // require('./image.png')), in debug mode * resourcesDirDebug: "$buildDir/intermediates/res/merged/debug", * * // where to put drawable resources / React Native assets, e.g. the ones you use via * // require('./image.png')), in release mode * resourcesDirRelease: "$buildDir/intermediates/res/merged/release", * * // by default the gradle tasks are skipped if none of the JS files or assets change; this means * // that we don't look at files in android/ or ios/ to determine whether the tasks are up to * // date; if you have any other folders that you want to ignore for performance reasons (gradle * // indexes the entire tree), add them here. Alternatively, if you have JS files in android/ * // for example, you might want to remove it from here. * inputExcludes: ["android/**", "ios/**"], * * // override which node gets called and with what additional arguments * nodeExecutableAndArgs: ["node"], * * // supply additional arguments to the packager * extraPackagerArgs: [] * ] */ project.ext.react = [ entryFile: "index.js" ] apply from: "../../node_modules/react-native/react.gradle" /** * Set this to true to create two separate APKs instead of one: * - An APK that only works on ARM devices * - An APK that only works on x86 devices * The advantage is the size of the APK is reduced by about 4MB. * Upload all the APKs to the Play Store and people will download * the correct one based on the CPU architecture of their device. */ def enableSeparateBuildPerCPUArchitecture = false /** * Run Proguard to shrink the Java bytecode in release builds. */ def enableProguardInReleaseBuilds = false android { compileSdkVersion rootProject.ext.compileSdkVersion buildToolsVersion rootProject.ext.buildToolsVersion defaultConfig { applicationId "com.reactnativecommunity.pushnotificationios" minSdkVersion rootProject.ext.minSdkVersion targetSdkVersion rootProject.ext.targetSdkVersion versionCode 1 versionName "1.0" } splits { abi { reset() enable enableSeparateBuildPerCPUArchitecture universalApk false // If true, also generate a universal APK include "armeabi-v7a", "x86", "arm64-v8a" } } buildTypes { release { minifyEnabled enableProguardInReleaseBuilds proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro" } } // applicationVariants are e.g. debug, release applicationVariants.all { variant -> variant.outputs.each { output -> // For each separate APK per architecture, set a unique version code as described here: // http://tools.android.com/tech-docs/new-build-system/user-guide/apk-splits def versionCodes = ["armeabi-v7a":1, "x86":2, "arm64-v8a": 3] def abi = output.getFilter(OutputFile.ABI) if (abi != null) { // null for the universal-debug, universal-release variants output.versionCodeOverride = versionCodes.get(abi) * 1048576 + defaultConfig.versionCode } } } } dependencies { implementation fileTree(dir: "libs", include: ["*.jar"]) implementation "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}" implementation "com.facebook.react:react-native:+" // From node_modules } // Run this once to be able to run the application with BUCK // puts all compile dependencies into folder libs for BUCK to use task copyDownloadableDepsToLibs(type: Copy) { from configurations.compile into 'libs' } ================================================ FILE: android/app/build_defs.bzl ================================================ """Helper definitions to glob .aar and .jar targets""" def create_aar_targets(aarfiles): for aarfile in aarfiles: name = "aars__" + aarfile[aarfile.rindex("/") + 1:aarfile.rindex(".aar")] lib_deps.append(":" + name) android_prebuilt_aar( name = name, aar = aarfile, ) def create_jar_targets(jarfiles): for jarfile in jarfiles: name = "jars__" + jarfile[jarfile.rindex("/") + 1:jarfile.rindex(".jar")] lib_deps.append(":" + name) prebuilt_jar( name = name, binary_jar = jarfile, ) ================================================ FILE: android/app/proguard-rules.pro ================================================ # Add project specific ProGuard rules here. # By default, the flags in this file are appended to flags specified # in /usr/local/Cellar/android-sdk/24.3.3/tools/proguard/proguard-android.txt # You can edit the include path and order by changing the proguardFiles # directive in build.gradle. # # For more details, see # http://developer.android.com/guide/developing/tools/proguard.html # Add any project specific keep options here: # If your project uses WebView with JS, uncomment the following # and specify the fully qualified class name to the JavaScript interface # class: #-keepclassmembers class fqcn.of.javascript.interface.for.webview { # public *; #} ================================================ FILE: android/app/src/main/AndroidManifest.xml ================================================ ================================================ FILE: android/app/src/main/java/com/pushnotificationios/MainActivity.java ================================================ package com.reactnativecommunity.pushnotificationios; import com.facebook.react.ReactActivity; public class MainActivity extends ReactActivity { /** * Returns the name of the main component registered from JavaScript. * This is used to schedule rendering of the component. */ @Override protected String getMainComponentName() { return "PushNotificationIOS"; } } ================================================ FILE: android/app/src/main/java/com/pushnotificationios/MainApplication.java ================================================ package com.reactnativecommunity.pushnotificationios; import android.app.Application; import com.facebook.react.ReactApplication; import com.facebook.react.ReactNativeHost; import com.facebook.react.ReactPackage; import com.facebook.react.shell.MainReactPackage; import com.facebook.soloader.SoLoader; import java.util.Arrays; import java.util.List; public class MainApplication extends Application implements ReactApplication { private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) { @Override public boolean getUseDeveloperSupport() { return BuildConfig.DEBUG; } @Override protected List getPackages() { return Arrays.asList( new MainReactPackage() ); } @Override protected String getJSMainModuleName() { return "index"; } }; @Override public ReactNativeHost getReactNativeHost() { return mReactNativeHost; } @Override public void onCreate() { super.onCreate(); SoLoader.init(this, /* native exopackage */ false); } } ================================================ FILE: android/app/src/main/res/values/strings.xml ================================================ PushNotificationIOS ================================================ FILE: android/app/src/main/res/values/styles.xml ================================================ ================================================ FILE: android/build.gradle ================================================ // Top-level build file where you can add configuration options common to all sub-projects/modules. buildscript { ext { buildToolsVersion = "28.0.2" minSdkVersion = 16 compileSdkVersion = 28 targetSdkVersion = 27 supportLibVersion = "28.0.0" } repositories { google() mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:3.2.1' // NOTE: Do not place your application dependencies here; they belong // in the individual module build.gradle files } } allprojects { repositories { mavenLocal() google() mavenCentral() maven { // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm url "$rootDir/../node_modules/react-native/android" } } } task wrapper(type: Wrapper) { gradleVersion = '4.7' distributionUrl = distributionUrl.replace("bin", "all") } ================================================ FILE: android/gradle/wrapper/gradle-wrapper.properties ================================================ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists distributionUrl=https\://services.gradle.org/distributions/gradle-4.7-all.zip ================================================ FILE: android/gradle.properties ================================================ # Project-wide Gradle settings. # IDE (e.g. Android Studio) users: # Gradle settings configured through the IDE *will override* # any settings specified in this file. # For more details on how to configure your build environment visit # http://www.gradle.org/docs/current/userguide/build_environment.html # Specifies the JVM arguments used for the daemon process. # The setting is particularly useful for tweaking memory settings. # Default value: -Xmx10248m -XX:MaxPermSize=256m # org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 # When configured, Gradle will run in incubating parallel mode. # This option should only be used with decoupled projects. More details, visit # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects # org.gradle.parallel=true ================================================ FILE: android/gradlew ================================================ #!/usr/bin/env sh ############################################################################## ## ## Gradle start up script for UN*X ## ############################################################################## # Attempt to set APP_HOME # Resolve links: $0 may be a link PRG="$0" # Need this for relative symlinks. while [ -h "$PRG" ] ; do ls=`ls -ld "$PRG"` link=`expr "$ls" : '.*-> \(.*\)$'` if expr "$link" : '/.*' > /dev/null; then PRG="$link" else PRG=`dirname "$PRG"`"/$link" fi done SAVED="`pwd`" cd "`dirname \"$PRG\"`/" >/dev/null APP_HOME="`pwd -P`" cd "$SAVED" >/dev/null APP_NAME="Gradle" APP_BASE_NAME=`basename "$0"` # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. DEFAULT_JVM_OPTS="" # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD="maximum" warn () { echo "$*" } die () { echo echo "$*" echo exit 1 } # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false nonstop=false case "`uname`" in CYGWIN* ) cygwin=true ;; Darwin* ) darwin=true ;; MINGW* ) msys=true ;; NONSTOP* ) nonstop=true ;; esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables JAVACMD="$JAVA_HOME/jre/sh/java" else JAVACMD="$JAVA_HOME/bin/java" fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else JAVACMD="java" which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi # Increase the maximum file descriptors if we can. if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then MAX_FD_LIMIT=`ulimit -H -n` if [ $? -eq 0 ] ; then if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then MAX_FD="$MAX_FD_LIMIT" fi ulimit -n $MAX_FD if [ $? -ne 0 ] ; then warn "Could not set maximum file descriptor limit: $MAX_FD" fi else warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" fi fi # For Darwin, add options to specify how the application appears in the dock if $darwin; then GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" fi # For Cygwin, switch paths to Windows format before running java if $cygwin ; then APP_HOME=`cygpath --path --mixed "$APP_HOME"` CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` JAVACMD=`cygpath --unix "$JAVACMD"` # We build the pattern for arguments to be converted via cygpath ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` SEP="" for dir in $ROOTDIRSRAW ; do ROOTDIRS="$ROOTDIRS$SEP$dir" SEP="|" done OURCYGPATTERN="(^($ROOTDIRS))" # Add a user-defined pattern to the cygpath arguments if [ "$GRADLE_CYGPATTERN" != "" ] ; then OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" fi # Now convert the arguments - kludge to limit ourselves to /bin/sh i=0 for arg in "$@" ; do CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` else eval `echo args$i`="\"$arg\"" fi i=$((i+1)) done case $i in (0) set -- ;; (1) set -- "$args0" ;; (2) set -- "$args0" "$args1" ;; (3) set -- "$args0" "$args1" "$args2" ;; (4) set -- "$args0" "$args1" "$args2" "$args3" ;; (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; esac fi # Escape application args save () { for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done echo " " } APP_ARGS=$(save "$@") # Collect all arguments for the java command, following the shell quoting and substitution rules eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then cd "$(dirname "$0")" fi exec "$JAVACMD" "$@" ================================================ FILE: android/gradlew.bat ================================================ @if "%DEBUG%" == "" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @rem @rem ########################################################################## @rem Set local scope for the variables with windows NT shell if "%OS%"=="Windows_NT" setlocal set DIRNAME=%~dp0 if "%DIRNAME%" == "" set DIRNAME=. set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. set DEFAULT_JVM_OPTS= @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 if "%ERRORLEVEL%" == "0" goto init echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. echo. echo Please set the JAVA_HOME variable in your environment to match the echo location of your Java installation. goto fail :findJavaFromJavaHome set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe if exist "%JAVA_EXE%" goto init echo. echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% echo. echo Please set the JAVA_HOME variable in your environment to match the echo location of your Java installation. goto fail :init @rem Get command-line arguments, handling Windows variants if not "%OS%" == "Windows_NT" goto win9xME_args :win9xME_args @rem Slurp the command line arguments. set CMD_LINE_ARGS= set _SKIP=2 :win9xME_args_slurp if "x%~1" == "x" goto execute set CMD_LINE_ARGS=%* :execute @rem Setup the command line set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar @rem Execute Gradle "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% :end @rem End local scope for the variables with windows NT shell if "%ERRORLEVEL%"=="0" goto mainEnd :fail rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem the _cmd.exe /c_ return code! if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 exit /b 1 :mainEnd if "%OS%"=="Windows_NT" endlocal :omega ================================================ FILE: android/keystores/BUCK ================================================ keystore( name = "debug", properties = "debug.keystore.properties", store = "debug.keystore", visibility = [ "PUBLIC", ], ) ================================================ FILE: android/keystores/debug.keystore.properties ================================================ key.store=debug.keystore key.alias=androiddebugkey key.store.password=android key.alias.password=android ================================================ FILE: android/settings.gradle ================================================ rootProject.name = 'PushNotificationIOS' include ':app' ================================================ FILE: babel.config.js ================================================ module.exports = { presets: ['module:metro-react-native-babel-preset'], plugins: [ [ 'module-resolver', { alias: { '@react-native-community/push-notification-ios': './js', }, cwd: 'babelrc', }, ], ], }; ================================================ FILE: docs/manual-linking.md ================================================ # Manual linking - Add the `.xcodeproj` to your project ``` node_modules/@react-native-community/push-notification-ios/ios/PushNotificationIOS.xcodeproj ``` - Add the following to `Link Binary With Libraries` phase ``` libRNCPushNotificationIOS.a ``` More info on manual linking, [here](https://reactnative.dev/docs/linking-libraries-ios). ================================================ FILE: example/.gitattributes ================================================ # Windows files should use crlf line endings # https://help.github.com/articles/dealing-with-line-endings/ *.bat text eol=crlf ================================================ FILE: example/.gitignore ================================================ # OSX # .DS_Store # Xcode # build/ *.pbxuser !default.pbxuser *.mode1v3 !default.mode1v3 *.mode2v3 !default.mode2v3 *.perspectivev3 !default.perspectivev3 xcuserdata *.xccheckout *.moved-aside DerivedData *.hmap *.ipa *.xcuserstate # Android/IntelliJ # build/ .idea .gradle local.properties *.iml # node.js # node_modules/ npm-debug.log yarn-error.log # BUCK buck-out/ \.buckd/ *.keystore !debug.keystore # fastlane # # It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the # screenshots whenever they are needed. # For more information about the recommended setup visit: # https://docs.fastlane.tools/best-practices/source-control/ */fastlane/report.xml */fastlane/Preview.html */fastlane/screenshots # Bundle artifact *.jsbundle # CocoaPods /ios/Pods/ ================================================ FILE: example/.watchmanconfig ================================================ {} ================================================ FILE: example/App.js ================================================ /** * Sample React Native App * https://github.com/facebook/react-native * * @flow */ import * as React from 'react'; import {useState, useEffect} from 'react'; import { Alert, StyleSheet, Text, Pressable, ScrollView, View, DeviceEventEmitter, SafeAreaView, } from 'react-native'; import PushNotificationIOS from '../js'; type ButtonProps = {| onPress: () => void | Promise, label: string, |}; const Button: React.StatelessFunctionalComponent = ({ onPress, label, }) => { return ( /** $FlowFixMe */ {label} ); }; export const App = (): React.Node => { const [permissions, setPermissions] = useState({}); useEffect(() => { PushNotificationIOS.addEventListener('register', onRegistered); PushNotificationIOS.addEventListener( 'registrationError', onRegistrationError, ); PushNotificationIOS.addEventListener('notification', onRemoteNotification); PushNotificationIOS.addEventListener( 'localNotification', onLocalNotification, ); PushNotificationIOS.requestPermissions({ alert: true, badge: true, sound: true, critical: true, }).then( (data) => { console.log('PushNotificationIOS.requestPermissions', data); }, (data) => { console.log('PushNotificationIOS.requestPermissions failed', data); }, ); return () => { PushNotificationIOS.removeEventListener('register'); PushNotificationIOS.removeEventListener('registrationError'); PushNotificationIOS.removeEventListener('notification'); PushNotificationIOS.removeEventListener('localNotification'); }; // eslint-disable-next-line react-hooks/exhaustive-deps }, []); const sendNotification = () => { DeviceEventEmitter.emit('remoteNotificationReceived', { remote: true, aps: { alert: {title: 'title', subtitle: 'subtitle', body: 'body'}, badge: 1, sound: 'default', category: 'REACT_NATIVE', 'content-available': 1, 'mutable-content': 1, }, }); }; const sendSilentNotification = () => { DeviceEventEmitter.emit('remoteNotificationReceived', { remote: true, aps: { category: 'REACT_NATIVE', 'content-available': 1, }, }); }; const sendLocalNotification = () => { PushNotificationIOS.presentLocalNotification({ alertTitle: 'Sample Title', alertBody: 'Sample local notification', applicationIconBadgeNumber: 1, }); }; const sendLocalNotificationWithSound = () => { PushNotificationIOS.addNotificationRequest({ id: 'notificationWithSound', title: 'Sample Title', subtitle: 'Sample Subtitle', body: 'Sample local notification with custom sound', sound: 'customSound.wav', badge: 1, }); }; const scheduleLocalNotification = () => { PushNotificationIOS.scheduleLocalNotification({ alertBody: 'Test Local Notification', fireDate: new Date(new Date().valueOf() + 2000).toISOString(), }); }; const addNotificationRequest = () => { PushNotificationIOS.addNotificationRequest({ id: 'test', title: 'title', subtitle: 'subtitle', body: 'body', category: 'test', threadId: 'thread-id', fireDate: new Date(new Date().valueOf() + 2000), repeats: true, userInfo: { image: 'https://www.github.com/Naturalclar.png', }, }); }; const addCriticalNotificationRequest = () => { PushNotificationIOS.addNotificationRequest({ id: 'critical', title: 'Critical Alert', subtitle: 'subtitle', body: 'This is a critical alert', category: 'test', threadId: 'thread-id', isCritical: true, fireDate: new Date(new Date().valueOf() + 2000), repeats: true, }); }; const addMultipleRequests = () => { PushNotificationIOS.addNotificationRequest({ id: 'test-1', title: 'First', subtitle: 'subtitle', body: 'First Notification out of 3', category: 'test', threadId: 'thread-id', fireDate: new Date(new Date().valueOf() + 10000), repeats: true, }); PushNotificationIOS.addNotificationRequest({ id: 'test-2', title: 'Second', subtitle: 'subtitle', body: 'Second Notification out of 3', category: 'test', threadId: 'thread-id', fireDate: new Date(new Date().valueOf() + 12000), repeats: true, }); PushNotificationIOS.addNotificationRequest({ id: 'test-3', title: 'Third', subtitle: 'subtitle', body: 'Third Notification out of 3', category: 'test', threadId: 'thread-id', fireDate: new Date(new Date().valueOf() + 14000), repeats: true, }); }; const getPendingNotificationRequests = () => { PushNotificationIOS.getPendingNotificationRequests((requests) => { Alert.alert('Push Notification Received', JSON.stringify(requests), [ { text: 'Dismiss', onPress: null, }, ]); }); }; const setNotificationCategories = async () => { PushNotificationIOS.setNotificationCategories([ { id: 'test', actions: [ {id: 'open', title: 'Open', options: {foreground: true}}, { id: 'ignore', title: 'Desruptive', options: {foreground: true, destructive: true}, }, { id: 'text', title: 'Text Input', options: {foreground: true}, textInput: {buttonTitle: 'Send'}, }, ], }, ]); Alert.alert( 'setNotificationCategories', `Set notification category complete`, [ { text: 'Dismiss', onPress: null, }, ], ); }; const removeAllPendingNotificationRequests = () => { PushNotificationIOS.removeAllPendingNotificationRequests(); }; const removePendingNotificationRequests = () => { PushNotificationIOS.removePendingNotificationRequests(['test-1', 'test-2']); }; const onRegistered = (deviceToken) => { Alert.alert('Registered For Remote Push', `Device Token: ${deviceToken}`, [ { text: 'Dismiss', onPress: null, }, ]); }; const onRegistrationError = (error) => { Alert.alert( 'Failed To Register For Remote Push', `Error (${error.code}): ${error.message}`, [ { text: 'Dismiss', onPress: null, }, ], ); }; const onRemoteNotification = (notification) => { const isClicked = notification.getData().userInteraction === 1; const result = ` Title: ${notification.getTitle()};\n Subtitle: ${notification.getSubtitle()};\n Message: ${notification.getMessage()};\n badge: ${notification.getBadgeCount()};\n sound: ${notification.getSound()};\n category: ${notification.getCategory()};\n content-available: ${notification.getContentAvailable()};\n Notification is clicked: ${String(isClicked)}.`; if (notification.getTitle() == undefined) { Alert.alert('Silent push notification Received', result, [ { text: 'Send local push', onPress: sendLocalNotification, }, ]); } else { Alert.alert('Push Notification Received', result, [ { text: 'Dismiss', onPress: null, }, ]); } notification.finish('UIBackgroundFetchResultNoData') }; const onLocalNotification = (notification) => { const isClicked = notification.getData().userInteraction === 1; Alert.alert( 'Local Notification Received', `Alert title: ${notification.getTitle()}, Alert subtitle: ${notification.getSubtitle()}, Alert message: ${notification.getMessage()}, Badge: ${notification.getBadgeCount()}, Sound: ${notification.getSound()}, Thread Id: ${notification.getThreadID()}, Action Id: ${notification.getActionIdentifier()}, User Text: ${notification.getUserText()}, Notification is clicked: ${String(isClicked)}.`, [ { text: 'Dismiss', onPress: null, }, ], ); }; const showPermissions = () => { PushNotificationIOS.checkPermissions((permissions) => { setPermissions({permissions}); }); }; return (