From 312c126cc8fe42ab83d959c79f250c5086835d2e Mon Sep 17 00:00:00 2001 From: Adam Duren Date: Sun, 2 Jun 2019 21:56:00 -0700 Subject: [PATCH] docs(firebase-messaging): update docs to support requestPermission forceShow and getToken tokenType options (#3047) --- .../plugins/firebase-messaging/index.ts | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/src/@ionic-native/plugins/firebase-messaging/index.ts b/src/@ionic-native/plugins/firebase-messaging/index.ts index 5ecbc5b1..dce189f5 100644 --- a/src/@ionic-native/plugins/firebase-messaging/index.ts +++ b/src/@ionic-native/plugins/firebase-messaging/index.ts @@ -31,6 +31,12 @@ export interface IFirebaseAPSMessage { export type IFirebaseMessage = IFirebaseAPSMessage | IFirebaseGCMMessage; +export interface IRequestPermissionOptions { + forceShow?: boolean; +} + +export type FirebaseMessagingTokenType = 'apns-buffer' | 'apns-string'; + /** * @beta * @name Firebase Messaging @@ -85,22 +91,27 @@ export class FirebaseMessaging extends IonicNativePlugin { } /** - * Grant permission to recieve push notifications (will trigger prompt on iOS). + * Grant permission to receive push notifications (will trigger prompt on iOS). * + * @param {IRequestPermissionOptions} [options] * @returns {Promise} */ @Cordova({ sync: true }) - requestPermission(): Promise { + requestPermission(options?: { forceShow?: boolean }): Promise { return; } /** * Returns a promise that fulfills with the current FCM token * + * This method also accepts optional argument type. + * Currently iOS implementation supports values "apns-buffer" and "apns-string" that defines presentation of resolved APNS token. + * + * @param {FirebaseMessagingTokenType} [type] iOS only. Defines presentation of resolved APNS token * @returns {Promise} */ @Cordova({ sync: true }) - getToken(): Promise { + getToken(type?: FirebaseMessagingTokenType): Promise { return; }