-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(fcm): support Firebase Cloud Messaging plugin (#1449)
* feat(): add fcm plugin * fix(): fix whitespace * fix(): add observables for methods * feat(): add NotificationData interface * doc(): improve examples in document * style(): remove usage examples from emthod declarations * fix(): decorate methods appropriately
- Loading branch information
Showing
1 changed file
with
118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
import { Plugin, IonicNativePlugin, Cordova } from '@ionic-native/core'; | ||
import { Injectable } from '@angular/core'; | ||
import { Observable } from 'rxjs/Observable'; | ||
|
||
export interface NotificationData { | ||
|
||
/** | ||
* Determines whether the notification was pressed or not | ||
*/ | ||
|
||
wasTapped: boolean; | ||
|
||
/** | ||
* Notification data hash item | ||
*/ | ||
|
||
[name: string]: any; | ||
|
||
} | ||
|
||
/** | ||
* @name FCM | ||
* @description | ||
* Provides basic functionality for Firebase Cloud Messaging | ||
* | ||
* @usage | ||
* ```typescript | ||
* import { FCM } from 'ionic-native'; | ||
* | ||
* constructor(private fcm: FCM) {} | ||
* | ||
* ... | ||
* | ||
* fcm.subscribeToTopic('marketing'); | ||
* | ||
* fcm.getToken().then(token=>{ | ||
* backend.registerToken(token); | ||
* }) | ||
* | ||
* fcm.onNotification().subscribe(data=>{ | ||
* if(data.wasPressed){ | ||
* console.log("Received in background"); | ||
* } else { | ||
* console.log("Received in foreground"); | ||
* }; | ||
* }) | ||
* | ||
* fcm.onTokenRefresh().subscribe(token=>{ | ||
* backend.registerToken(token); | ||
* }) | ||
* | ||
* fcm.unsubscribeToTopic('marketing'); | ||
* | ||
* ``` | ||
* @interfaces | ||
* NotificationData | ||
*/ | ||
@Plugin({ | ||
pluginName: 'FCM', | ||
plugin: 'cordova-plugin-fcm', | ||
pluginRef: 'FCMPlugin', | ||
repo: 'https://github.com/fechanique/cordova-plugin-fcm', | ||
platforms: ['iOS', 'Android'] | ||
}) | ||
@Injectable() | ||
export class FCM extends IonicNativePlugin { | ||
|
||
/** | ||
* Get's device's current registration id | ||
* | ||
* @returns {Promise<string>} Returns a Promise that resolves with the registration id token | ||
*/ | ||
@Cordova() | ||
getToken(): Promise<string> { return; } | ||
|
||
/** | ||
* Event firing on the token refresh | ||
* | ||
* @returns {Observable<string>} Returns an Observable that notifies with the change of device's registration id | ||
*/ | ||
@Cordova({ | ||
observable: true | ||
}) | ||
onTokenRefresh(): Observable<string> { return; } | ||
|
||
/** | ||
* Subscribes you to a [topic](https://firebase.google.com/docs/notifications/android/console-topics) | ||
* | ||
* @param {string} topic Topic to be subscribed to | ||
* | ||
* @returns {Promise<any>} Returns a promise resolving in result of subscribing to a topic | ||
*/ | ||
@Cordova() | ||
subscribeToTopic(topic: string): Promise<any> { return; } | ||
|
||
/** | ||
* Unubscribes you from a [topic](https://firebase.google.com/docs/notifications/android/console-topics) | ||
* | ||
* @param {string} topic Topic to be unsubscribed from | ||
* | ||
* @returns {Promise<any>} Returns a promise resolving in result of unsubscribing from a topic | ||
*/ | ||
@Cordova() | ||
unsubscribeToTopic(topic: string): Promise<any> { return; } | ||
|
||
/** | ||
* Watch for incoming notifications | ||
* | ||
* @returns {Observable<any>} returns an object with data from the notification | ||
*/ | ||
@Cordova({ | ||
observable: true, | ||
successIndex: 0, | ||
errorIndex: 2 | ||
}) | ||
onNotification(): Observable<NotificationData> { return; } | ||
|
||
} |