https://github.com/edusperoni/nativescript-shared-notification-delegate

https://github.com/edusperoni/nativescript-shared-notification-delegate

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/edusperoni/nativescript-shared-notification-delegate
• Owner: edusperoni
• License: apache-2.0
• Created: 2019-03-28T17:26:21.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-09-29T17:41:10.000Z (over 3 years ago)
• Last Synced: 2024-12-27T18:05:19.174Z (10 days ago)
• Language: TypeScript
• Size: 1.91 MB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nativescript Shared Notification Delegate

This project aims to prevent the shortcomings that come from the iOS implementation of only allowing a single delegate.

## Installation

```javascript

tns plugin add nativescript-shared-notification-delegate

```

## Usage 

Import `SharedNotificationDelegate` and add Observers

	

```typescript

import { SharedNotificationDelegate } from 'nativescript-shared-notification-delegate';

...

SharedNotificationDelegate.addObserver({

    delegateUniqueKey: "myUniqueKey", // ensures uniqueness, if not set or is null/undefined, allows multiple of the same

    userNotificationCenterWillPresentNotificationWithCompletionHandler: (notificationCenter, notification, handler, stop, next) => {

        console.log("notification received by observer");

        // is this notification something I should handle?

        if (shouldHandleThis) {

            // do stuff

            // intercept it and show alert

            handler(UNNotificationPresentationOptions.Alert);

            return;

        }

        // not mine, next should handle

        next();

    }

});

```

## API

#### SharedNotificationDelegate Methods

| Method |  Description |

| --- | --- |

| addObserver(observer: `DelegateObserver`, priority?: `number`): `void` | Adds a delegate observer of a certain priority (lower means first). Default priority is 100. |

| removeObserver(observer: `DelegateObserver`) | removes a DelegateObserver |

| removeObserverByUniqueKey(key: `any`) | removes a DelegateObserver by its unique key |

#### DelegateObserver Interface

A DelegateObserver can implement 3 methods from `UNUserNotificationCenterDelegate` with the addition of some details:

```typescript

interface DelegateObserver {

    userNotificationCenterDidReceiveNotificationResponseWithCompletionHandler?(center: any /* UNUserNotificationCenter */, response: any /* UNNotificationResponse */, completionHandler: () => void, next: () => void): void;

    userNotificationCenterOpenSettingsForNotification?(center: any /* UNUserNotificationCenter */, notification: any /* UNNotification */, stop: () => void, next: () => void): void;

    userNotificationCenterWillPresentNotificationWithCompletionHandler?(center: any /* UNUserNotificationCenter */, notification: any /* UNNotification */, completionHandler: (p1: any /* UNNotificationPresentationOptions */) => void, next: () => void): void;

    /**

     * if set to not null/undefined, will ensure only one is registered

     */

    delegateUniqueKey?: any;

}

```

All the functions are called asynchronously in a chain.

Calling a `completionHandler` immediately stops the observer chain. `next()` **must** be called if the method will not be handling the notification.

Calling `stop()` on `userNotificationCenterOpenSettingsForNotification` prevents the event bubbling to the rest.

Only one method will be processed at a time, this means you can take as long as you want (including making http calls, for example), as long as you just call `completionHandler`, `stop` and `next` when you're finished.

If a DelegateObserver has a `delegateUniqueKey`, the `SharedNotificationDelegate` will ensure only the latest copy of the observer is present. This is especially useful if debugging with HMR, which may add multiple observers on application reload.

    

## License

Apache License Version 2.0, January 2004