diff --git a/docs/pushnotificationios.html b/docs/pushnotificationios.html index ec80743475d..e3bf8565421 100644 --- a/docs/pushnotificationios.html +++ b/docs/pushnotificationios.html @@ -1,6 +1,14 @@ -React Native | A framework for building native apps using React
React Native

Quick Start

Guides

components

apis

Polyfills

PushNotificationIOS

All rights reserved.

This source code is licensed under the BSD-style license found in the -LICENSE file in the root directory of this source tree. An additional grant -of patent rights can be found in the PATENTS file in the same directory.

@flow

Methods #

static setApplicationIconBadgeNumber(number) #

static getApplicationIconBadgeNumber(callback) #

static addEventListener(type, handler) #

static requestPermissions() #

static checkPermissions(callback) #

static removeEventListener(type, handler) #

static popInitialNotification() #

constructor(nativeNotif) #

getMessage() #

getSound() #

getAlert() #

getBadgeCount() #

getData() #

Next →
React Native

Quick Start

Guides

components

apis

Polyfills

PushNotificationIOS

Handle push notifications for your app, including permission handling and +icon badge number.

To get up and running, configure your notifications with Apple +and your server-side system. To get an idea, this is the Parse guide.

Methods #

static setApplicationIconBadgeNumber(number: number) #

Sets the badge number for the app icon on the home screen

static getApplicationIconBadgeNumber(callback: Function) #

Gets the current badge number for the app icon on the home screen

static addEventListener(type: string, handler: Function) #

Attaches a listener to remote notifications while the app is running in the +foreground or the background.

The handler will get be invoked with an instance of PushNotificationIOS

static requestPermissions() #

Requests all notification permissions from iOS, prompting the user's +dialog box.

static checkPermissions(callback: Function) #

See what push permissions are currently enabled. callback will be +invoked with a permissions object:

  • alert :boolean
  • badge :boolean
  • sound :boolean

static removeEventListener(type: string, handler: Function) #

Removes the event listener. Do this in componentWillUnmount to prevent +memory leaks

static popInitialNotification() #

An initial notification will be available if the app was cold-launched +from a notification.

The first caller of popInitialNotification will get the initial +notification object, or null. Subsequent invocations will return null.

constructor(nativeNotif) #

You will never need to instansiate PushNotificationIOS yourself. +Listening to the notification event and invoking +popInitialNotification is sufficient

getMessage() #

An alias for getAlert to get the notification's main message string

getSound() #

Gets the sound string from the aps object

getAlert() #

Gets the notification's main message from the aps object

getBadgeCount() #

Gets the badge count number from the aps object

getData() #

Gets the data object on the notif

Next →