pushwoosh-react-native-plugin 2.0.0 → 2.2.17

package/docs/README.md

@@ -1,3 +1,4 @@
+
 # Pushwoosh React Native Module #
 
 Provides module for React Native to receive and handle push notifications for iOS and Android.
@@ -17,13 +18,17 @@ Pushwoosh.register(
     console.warn("Failed to register for push notifications: " + error);
   }
 );
-```
 
-<style>
-td {
-  background-color:#FFFFFF;
-}
-</style>
+// 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));
+});
+```
 
 <br>
 <h3>Summary</h3>
@@ -34,14 +39,34 @@ td {
 <th align="left" colspan="2"><strong>Functions</strong></th>
 </tr>
 <tr class="even"><td><a href="#init">init(config, success, fail)</a></td></tr>
-<tr class="odd"><td><a href="#register">register(success, fail)</a></td></tr>
+<tr class="even"><td><a href="#register">register(success, fail)</a></td></tr>
 <tr class="even"><td><a href="#unregister">unregister(success, fail)</a></td></tr>
-<tr class="odd"><td><a href="#settags">setTags(tags, success, fail)</a></td></tr>
+<tr class="even"><td><a href="#settags">setTags(tags, success, fail)</a></td></tr>
 <tr class="even"><td><a href="#gettags">getTags(success, fail)</a></td></tr>
-<tr class="odd"><td><a href="#getpushtoken">getPushToken(success)</a></td></tr>
+<tr class="even"><td><a href="#getpushtoken">getPushToken(success)</a></td></tr>
 <tr class="even"><td><a href="#gethwid">getHwid(success)</a></td></tr>
-<tr class="even"><td><a href="#setuserid">setUserId(userId)</a></td></tr>
+<tr class="even"><td><a href="#setuserid">setUserId(userId, success, fail)</a></td></tr>
 <tr class="even"><td><a href="#postevent">postEvent(event, attributes)</a></td></tr>
+<tr class="even"><td><a href="#setapplicationiconbadgenumber">setApplicationIconBadgeNumber(badgeNumber)</a></td></tr>
+<tr class="even"><td><a href="#getapplicationiconbadgenumber">getApplicationIconBadgeNumber(callback)</a></td></tr>
+<tr class="even"><td><a href="#addtoapplicationiconbadgenumber">addToApplicationIconBadgeNumber(badgeNumber)</a></td></tr>
+<tr class="even"><td><a href="#setmultinotificationmode">setMultiNotificationMode(on)</a></td></tr>
+<tr class="even"><td><a href="#setlightscreenonnotification">setLightScreenOnNotification(on)</a></td></tr>
+<tr class="even"><td><a href="#setenableled">setEnableLED(on)</a></td></tr>
+<tr class="even"><td><a href="#setcolorled">setColorLED(color)</a></td></tr>
+<tr class="even"><td><a href="#setsoundtype">setSoundType(type)</a></td></tr>
+<tr class="even"><td><a href="#setvibratetype">setVibrateType(type)</a></td></tr>
+<tr class="even"><td><a href="#presentinboxui">presentInboxUI()</a></td></tr>
+<tr class="even"><td><a href="#showgdprconsentui">showGDPRConsentUI()</a></td></tr>
+<tr class="even"><td><a href="#showgdprdeletionui">showGDPRDeletionUI()</a></td></tr>
+<tr class="even"><td><a href="#setcommunicationenabled">setCommunicationEnabled()</a></td></tr>
+<tr class="even"><td><a href="#removealldevicedata">removeAllDeviceData()</a></td></tr>
+<tr class="even"><td><a href="#enableHuaweiPushNotifications">enableHuaweiPushNotifications()</a></td></tr>
+<tr>
+<th align="left" colspan="2"><strong>Events</strong></th>
+</tr>
+<tr class="even"><td><a href="#pushopened">pushOpened</a></td></tr>
+<tr class="even"><td><a href="#pushreceived">pushReceived</a></td></tr>
 </tbody>
 </table>
 <hr />
@@ -68,6 +93,8 @@ Initializes Pushwoosh module with application id and google project number.
 <tr class="even"><td>object</td><td><b>config</b></td><td>Pushwoosh initialization config.</td></tr>
 <tr class="even"><td>string</td><td><b>config.pw_appid</b></td><td>Pushwoosh application id.</td></tr>
 <tr class="even"><td>string</td><td><b>config.project_number</b></td><td>GCM project number (for Android push notifications).</td></tr>
+<tr class="even"><td>string</td><td><b>config.reverse_proxy_url</b></td><td>(optional) Url to your reverse proxy.</td></tr>
+<tr class="even"><td>string</td><td><b>config.pw_notification_handling</b></td><td>(optional) To use custom notification handling on iOS specify the parameter "pw_notification_handling" to "CUSTOM".</td></tr>
 <tr class="even"><td>function</td><td><b>success</b></td><td>(optional) initialization success callback.</td></tr>
 <tr class="even"><td>function</td><td><b>fail</b></td><td>(optional) initialization failure callback.</td></tr>
 </tbody>
@@ -244,7 +271,7 @@ Returns Pushwoosh HWID used for communications with Pushwoosh API.
 ### setUserId
 
 ```js
-setUserId(userId)
+setUserId(userId, success, fail)
 ```
 
 Set User indentifier. This could be Facebook ID, username or email, or any other user ID.
@@ -261,6 +288,8 @@ This allows data and events to be matched across multiple user devices.
 <th align="left" colspan="3"><strong>Parameters</strong></th>
 </tr>
 <tr class="even"><td>string</td><td><b>userId</b></td><td>Identifier of currently logged in user</td></tr>
+<tr class="even"><td>function</td><td><b>success</b></td><td>(optional) method success callback.</td></tr>
+<tr class="even"><td>function</td><td><b>fail</b></td><td>(optional) method failure callback.</td></tr>
 </tbody>
 </table>
 
@@ -294,3 +323,193 @@ 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.
+
+
+### showGDPRConsentUI
+
+```js
+showGDPRConsentUI()
+```
+**[android, ios]**  
+A part of [The GDPR Compliance](https://www.pushwoosh.com/docs/the-gdpr-compliance) solution that shows the GDPR Consent Form, ensuring lawful basis for processing personal data of EU citizens.
+
+
+### showGDPRDeletionUI
+
+```js
+showGDPRDeletionUI()
+```
+**[android, ios]**  
+A part of [The GDPR Compliance](https://www.pushwoosh.com/docs/the-gdpr-compliance) solution that shows the GDPR Deletion Form, ensuring means to comply with the right to erasure.
+
+
+### 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.
+
+
+### removeAllDeviceData
+
+```js
+removeAllDeviceData()
+```
+**[android, ios]**  
+Removes all data about the device. Cannot be undone.
+
+### enableHuaweiPushNotifications
+
+```js
+enableHuaweiPushNotifications()
+```
+**[android]**  
+Enables Huawei push messaging. Requires configured Huawei platform for your Pushwoosh application. See the <a href="https://docs.pushwoosh.com/platform-docs/pushwoosh-sdk/android-push-notifications/huawei-integration/huawei-in-react-native">integration guide</a>.
+
+### 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.

package/index.d.ts

@@ -0,0 +1,91 @@
+declare module 'pushwoosh-react-native-plugin' {
+  interface PushwooshConfig {
+    pw_appid: string;
+    project_number: string;
+    pw_notification_handling?: string;
+  }
+  type LocalNotification = {
+    msg: string;
+    seconds: number;
+    userData?: Object;
+  }
+
+  type PushwooshTags = Record<string, string | number | string[] | number[] | boolean>
+
+  type InboxNotification = {
+    code: string;
+    title?: string;
+    message?: string;
+    imageUrl?: string;
+    sendDate?: string;
+    type?: number;
+    bannerUrl?: string;
+    customData?: Object;
+    isRead?: boolean;
+    actionParams?: Object;
+    isActionPerformed?: boolean;
+  }
+
+  interface Pushwoosh {
+    //general interaction with Pushwoosh
+    init(config: PushwooshConfig, success?: () => void, fail?: () => void): void;
+    createLocalNotification(notification: LocalNotification): void;
+    clearLocalNotification(): void;
+    clearNotificationCenter(): void;
+    register(success?: (token: string) => void, fail?: (error: Error) => void): void;
+    unregister(success?: (token: string) => void, fail?: (error: Error) => void): void;
+    onPushOpen(callback: () => void, fail?: ()=> void): void; 
+    setTags(
+      tags: PushwooshTags,
+      success?: () => void,
+      fail?: (error: Error) => void
+    ): void;
+    getTags(success: (tags: PushwooshTags) => void, fail?: (error: Error) => void): void;
+    setShowPushnotificationAlert(showAlert: boolean): void;
+    getShowPushnotificationAlert(callback: (willShow: boolean) => void): void;
+    getPushToken(success?: (token: string) => void): void;
+    getHwid(success: (hwid: string) => void): void;
+    setUserId(userId: string, success?: ()=> void, fail?: (error: Error) => void): void;
+    postEvent(event: string, attributes?: Record<string, string>): void;
+    enableHuaweiPushNotifications(): void;
+
+    //badge methods
+    setApplicationIconBadgeNumber(badgeNumber: number): void;
+    getApplicationIconBadgeNumber(callback: (badge: number) => void): void;
+    addToApplicationIconBadgeNumber(badgeNumber: number): void;
+
+    //Notification appearance
+    setMultiNotificationMode(on: boolean): void;
+    setLightScreenOnNotification(on: boolean): void;
+    setEnableLED(on: boolean): void;
+    setColorLED(color: number): void;
+    setSoundType(type: number): void;
+    setVibrateType(type: number): void;
+    setNotificationIconBackgroundColor(color: string): void;
+    setLanguage(language: string): void;
+
+    //Inbox API
+    presentInboxUI(style?: Object): void;
+    messagesWithNoActionPerformedCount(callback: (result: number) => void): void;
+    unreadMessagesCount(callback: (result: number) => void): void;
+    messagesCount(callback: (result: number) => void): void;
+    loadMessages(success: (notifications: InboxNotification[]) => void, fail?: (error: Error) => void): void;
+    readMessage(id: string): void;
+    readMessages(ids: string[]): void;
+    deleteMessage(id: string): void;
+    deleteMessages(ids: string[]): void;
+    performAction(id: string): void;
+
+    //GDPR methods
+    showGDPRConsentUI(): void;
+    showGDPRDeletionUI(): void;
+    isDeviceDataRemoved(success: (isRemoved: boolean) => void): void;
+    isCommunicationEnabled(success: (isEnabled: boolean)=> void): void;
+    isAvailableGDPR(success: (isAvailable: boolean) => void): void;
+    setCommunicationEnabled(enabled: boolean, success?: () => void, fail?: (error: Error) => void): void;
+    removeAllDeviceData(success?: () => void, fail?: (error: Error) => void): void;
+  }
+
+  const Pushwoosh: Pushwoosh;
+  export = Pushwoosh;
+}