fix ts cancelLocalNotification prop (wix#754)

Author: DanielEliraz

README.md

@@ -20,7 +20,7 @@ Apps using React Native Notifications may target iOS 10 and Android 5.0 (API 21)
 
 ### iOS
 
-<img src="https://s3.amazonaws.com/nrjio/interactive.gif" alt="Interactive notifications example" width=350/>
+<!-- <img src="https://s3.amazonaws.com/nrjio/interactive.gif" alt="Interactive notifications example" width=350/> -->
 
 - Remote (push) notifications
 - Local notifications

lib/src/Notifications.ts

@@ -76,7 +76,7 @@ export class NotificationsRoot {
   /**
    * cancelLocalNotification
   */
-  public cancelLocalNotification(notificationId: string) {
+  public cancelLocalNotification(notificationId: number) {
     return this.commands.cancelLocalNotification(notificationId);
   }
 

lib/src/adapters/NativeCommandsSender.ts

@@ -15,7 +15,7 @@ interface NativeCommandsModule {
   registerPushKit(): void;
   getBadgeCount(): Promise<number>;
   setBadgeCount(count: number): void;
-  cancelLocalNotification(notificationId: string): void;
+  cancelLocalNotification(notificationId: number): void;
   cancelAllLocalNotifications(): void;
   isRegisteredForRemoteNotifications(): Promise<boolean>;
   checkPermissions(): Promise<NotificationPermissions>;
@@ -71,7 +71,7 @@ export class NativeCommandsSender {
     this.nativeCommandsModule.setBadgeCount(count);
   }
 
-  cancelLocalNotification(notificationId: string) {
+  cancelLocalNotification(notificationId: number) {
     this.nativeCommandsModule.cancelLocalNotification(notificationId);
   }
 

lib/src/commands/Commands.test.ts

@@ -150,8 +150,9 @@ describe('Commands', () => {
 
   describe('cancelLocalNotification', () => {
     it('sends to native', () => {
-      uut.cancelLocalNotification("notificationId");
-      verify(mockedNativeCommandsSender.cancelLocalNotification("notificationId")).called();
+      const notificationId = 1;
+      uut.cancelLocalNotification(notificationId);
+      verify(mockedNativeCommandsSender.cancelLocalNotification(notificationId)).called();
     });
   });
 

lib/src/commands/Commands.ts

@@ -56,7 +56,7 @@ export class Commands {
     this.nativeCommandsSender.setBadgeCount(count);
   }
 
-  public cancelLocalNotification(notificationId: string) {
+  public cancelLocalNotification(notificationId: number) {
     this.nativeCommandsSender.cancelLocalNotification(notificationId);
   }
 

website/docs/api/general-api.md

@@ -29,12 +29,12 @@ Notifications.postLocalNotification({
   sound: 'chime.aiff',
   category: 'SOME_CATEGORY',
   link: 'localNotificationLink',
-  fireDate: new Date()
+  fireDate: new Date() // only iOS
 }, id);
 ```
 
 ## cancelLocalNotification(id)
-Relevant for notifications sent with `fireDate`.
+Only iOS. Relevant for notifications sent with `fireDate`.
 
 ```js
 Notifications.cancelLocalNotification(id);

website/docs/docs/localNotifications.md

@@ -16,9 +16,10 @@ let localNotification = Notifications.postLocalNotification({
 	body: "Local notification!",
 	title: "Local Notification Title",
 	sound: "chime.aiff",
-    silent: false,
+	silent: false,
 	category: "SOME_CATEGORY",
-	userInfo: { }
+	userInfo: { },
+	fireDate: new Date(),
 });
 ```
 
@@ -45,7 +46,8 @@ let someLocalNotification = Notifications.postLocalNotification({
 	title: "Local Notification Title",
 	sound: "chime.aiff",
 	category: "SOME_CATEGORY",
-	userInfo: { }
+	userInfo: { },
+	fireDate: new Date(),
 });
 
 Notifications.cancelLocalNotification(someLocalNotification);
@@ -72,9 +74,9 @@ Call `removeAllDeliveredNotifications()` to dismiss all delivered notifications
 notifications).
 
 
-<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/a/a0/APK_format_icon.png/768px-APK_format_icon.png" width={30}/> Android
+<img src="./../../static/img/Android_icon-icons.com_66772.png"/> Android
 
-Much like on iOS, notifications can be triggered locally. The API to do so is a simplified version of the iOS equivalent that works more natually with the Android perception of push (remote) notifications:
+Much like on iOS, notifications can be triggered locally. The API to do so is a simplified version of the iOS equivalent that works more naturally with the Android perception of push (remote) notifications:
 
 ```jsx
 Notifications.postLocalNotification({
@@ -84,4 +86,4 @@ Notifications.postLocalNotification({
 });
 ```
 
-Upon notification opening (tapping by the device user), all data fields will be delivered as-is). Note that scheduled notifications are not yet implemented on Android. See [Issue 484](https://github.com/wix/react-native-notifications/issues/484).
+Upon notification opening (tapping by the device user), all data fields will be delivered as-is. Note that scheduled notifications are not yet implemented on Android. See [Issue 484](https://github.com/wix/react-native-notifications/issues/484).