# Pushwoosh React Native Module # Provides module for React Native to receive and handle push notifications for iOS and Android. Example: ```js var Pushwoosh = require('pushwoosh-react-native-plugin'); Pushwoosh.init({ "pw_appid" : "PUSHWOOSH_APP_ID" }); Pushwoosh.register( (token) => { console.warn("Registered for push notifications with token: " + token); }, (error) => { console.warn("Failed to register for push notifications: " + error); } ); // this event is fired when the push is received in the app DeviceEventEmitter.addListener('pushReceived', (e: Event) => { console.warn("pushReceived: " + JSON.stringify(e)); }); // this event is fired when user clicks on notification DeviceEventEmitter.addListener('pushOpened', (e: Event) => { console.warn("pushOpened: " + JSON.stringify(e)); }); ```

Summary

Functions
init(config, success, fail)
register(success, fail)
unregister(success, fail)
setTags(tags, success, fail)
getTags(success, fail)
getPushToken(success)
getHwid(success)
setUserId(userId, success, fail)
postEvent(event, attributes)
setApplicationIconBadgeNumber(badgeNumber)
getApplicationIconBadgeNumber(callback)
addToApplicationIconBadgeNumber(badgeNumber)
setMultiNotificationMode(on)
setLightScreenOnNotification(on)
setEnableLED(on)
setColorLED(color)
setSoundType(type)
setVibrateType(type)
presentInboxUI()
setCommunicationEnabled()
enableHuaweiPushNotifications()
registerSMSNumber(phoneNumber)
registerWhatsappNumber(phoneNumber)
setReverseProxy(url, headers)
Events
pushOpened
pushReceived

### init ```js init(config, success, fail) ``` Initializes Pushwoosh module with application id.

Parameters
object	config	Pushwoosh initialization config.
string	config.pw_appid	Pushwoosh application id.
string	config.pw_notification_handling	(optional) To use custom notification handling on iOS specify the parameter "pw_notification_handling" to "CUSTOM".
function	success	(optional) initialization success callback.
function	fail	(optional) initialization failure callback.

### register ```js register(success, fail) ``` Registers current device for push notifications.

Parameters
function	success	(optional) registration success callback. Receives push token as parameter.
function	fail	(optional) registration failure callback.

NOTE: if user does not allow application to receive push notifications and `UIBackgroundModes remote-notificaion` is not set in **Info.plist** none of these callbacks will be called. ### unregister ```js unregister(success, fail) ``` Unregisters current deivce from receiving push notifications.

Parameters
function	success	(optional) deregistration success callback.
function	fail	(optional) deregistration failure callback.

### setTags ```js setTags(tags, success, fail) ``` Set tags associated with current device and application.

Parameters
object	tags	Tags associated with current device.
function	success	(optional) method success callback.
function	fail	(optional) method failure callback.

Example: ```js pushNotification.setTags({ "string_tag" : "Hello world", "int_tag" : 42, "list_tag":["hello", "world"]}); ``` ### getTags ```js getTags(success, fail) ``` Get tags associated with current device and application.

Parameters
function	success	(optional) method success callback. Receives object containing tags as parameter.
function	fail	(optional) method failure callback.

Example: ```js Pushwoosh.getTags( function(tags) { console.warn('tags for the device: ' + JSON.stringify(tags)); }, function(error) { console.warn('get tags error: ' + JSON.stringify(error)); } ); ``` ### getPushToken ```js getPushToken(success) ``` Returns push token or null if device is not registered for push notifications.

Parameters
function	success	Method success callback. Receives push token as parameter.

### getHwid ```js getHwid(success) ``` Returns Pushwoosh HWID used for communications with Pushwoosh API.

Parameters
function	success	Method success callback. Receives Pushwoosh HWID as parameter.

### setUserId ```js setUserId(userId, success, fail) ``` Set User indentifier. This could be Facebook ID, username or email, or any other user ID. This allows data and events to be matched across multiple user devices.

Parameters
string	userId	Identifier of currently logged in user
function	success	(optional) method success callback.
function	fail	(optional) method failure callback.

### postEvent ```js postEvent(event, attributes) ``` Post events for In-App Messages. This can trigger In-App message display as specified in Pushwoosh Control Panel.

Parameters
string	event	Event name.
object	attributes	Additional event data.

Example: ```js Pushwoosh.postEvent("buttonPressed", { "buttonNumber" : "4", "buttonLabel" : "Banner" }) ``` ### setApplicationIconBadgeNumber ```js setApplicationIconBadgeNumber(badgeNumber) ``` **[android, ios]** Set application icon badge number. |Parameter|Description| |-|-| |badgeNumber|Icon badge number| ### getApplicationIconBadgeNumber ```js getApplicationIconBadgeNumber(callback: Function) ``` **[android, ios]** Returns application icon badge number. ### addToApplicationIconBadgeNumber ```js addToApplicationIconBadgeNumber(badgeNumber: number) ``` **[android, ios]** Adds value to application icon badge. |Parameter|Description| |-|-| |badgeNumber|Incremental icon badge number| ### setMultiNotificationMode ```js setMultiNotificationMode(on: boolean) ``` **[android]** Allows multiple notifications to be displayed in the Android Notification Center. |Parameter|Description| |-|-| |on|Enable/disable multiple notifications (is disabled by default)| ### setLightScreenOnNotification ```js setLightScreenOnNotification(on: boolean) ``` **[android]** Turns screen on when notification arrives. |Parameter|Description| |-|-| |on|Enable/disable screen unlock (is disabled by default)| ### setEnableLED ```js setEnableLED(on: boolean) ``` **[android]** Enables LED blinking when notification arrives and display is off. |Parameter|Description| |-|-| |on|Enable/disable LED blink (disabled by default)| ### setColorLED ```js setColorLED(color: number) ``` **[android]** Set led color. Use with [setEnableLED](#setenableled). |Parameter|Description| |-|-| |color|LED color in ARGB integer format| ### setSoundType ```js setSoundType(type: number) ``` **[android]** Sets default sound for incoming push notifications. |Parameter|Description| |-|-| |type|Sound type (0 – default, 1 – no sound, 2 – always)| ### setVibrateType ```js setVibrateType(type: number) ``` **[android]** Sets default vibration mode for incoming push notifications. |Parameter|Description| |-|-| |type|Vibration type (0 – default, 1 – no vibration, 2 – always)| ### presentInboxUI ```js presentInboxUI() ``` Opens [Inbox](https://www.pushwoosh.com/docs/message-inbox) screen. Before using Message Inbox, please add node_modules/pushwoosh-react-native-plugin/src/ios/PushwooshInboxBundle.bundle to your project. Or, launch a script 'node node_modules/pushwoosh-react-native-plugin/scripts/add_inbox_ios_resources.js' to do it. ### setCommunicationEnabled ```js setCommunicationEnabled(on: boolean) ``` **[android, ios]** A binary method enabling/disabling all communication with Pushwoosh. The boolean value is false unsubscribes the device from receiving push notifications and stops in-app messages download. The value true reverses the effect. ### enableHuaweiPushNotifications ```js enableHuaweiPushNotifications() ``` **[android]** Enables Huawei push messaging. Requires configured Huawei platform for your Pushwoosh application. See the integration guide. ### registerSMSNumber ```js registerSMSNumber(phoneNumber) ``` **[android, ios]** Registers phone number associated to the current user. SMS numbers must be in E.164 format (e.g., "+1234567890") and be valid. ### registerWhatsappNumber ```js registerWhatsappNumber(phoneNumber) ``` **[android, ios]** Registers WhatsApp number associated to the current user. WhatsApp numbers must be in E.164 format (e.g., "+1234567890") and be valid. ### setReverseProxy ```js setReverseProxy(url, headers) ``` **[android, ios]** Routes all SDK network requests through a reverse proxy server. Must be called before `init()`.

Parameters
string	url	Reverse proxy URL.
object	headers	(optional) Custom HTTP headers for all requests.

**Prerequisites:** - **Android:** add `` to AndroidManifest.xml - **iOS:** add `Pushwoosh_ALLOW_REVERSE_PROXY = YES` to Info.plist Example: ```js Pushwoosh.setReverseProxy("https://your-proxy.example.com/", { "X-Proxy-Auth": "my-token" }); Pushwoosh.init({ "pw_appid": "XXXXX-XXXXX" }); ``` ### pushReceived ```js DeviceEventEmitter.addListener('pushReceived', (e: Event) => { console.warn("pushReceived: " + JSON.stringify(e)); // shows a push is received. Implement passive reaction to a push, such as UI update or data download. }); ``` **[android, ios]** Push notification received event is fired when push is received in app. ### pushOpened ```js DeviceEventEmitter.addListener('pushOpened', (e: Event) => { console.warn("pushOpened: " + JSON.stringify(e)); // shows a user tapped the notification. Implement user interaction, such as showing push details. }); ``` **[android, ios]** Push notification opened event is fired when user clicks on push notification.