import { Injectable } from '@angular/core'; import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; import { Observable } from 'rxjs/Observable'; /** * @name Firebase * @description * This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10). * * @usage * ```typescript * import { Firebase } from '@ionic-native/firebase'; * * constructor(private firebase: Firebase) { } * * ... * * this.firebase.getToken() * .then(token => console.log(`The token is ${token}`)) // save the token server-side and use it to push notifications to this device * .catch(error => console.error('Error getting token', error)); * * this.firebase.onNotificationOpen() * .subscribe(data => console.log(`User opened a notification ${data}`)); * * this.firebase.onTokenRefresh() * .subscribe((token: string) => console.log(`Got a new token ${token}`)); * * ``` */ @Plugin({ pluginName: 'Firebase', plugin: 'cordova-plugin-firebase', pluginRef: 'FirebasePlugin', repo: 'https://github.com/arnesson/cordova-plugin-firebase', platforms: ['Android', 'iOS'] }) @Injectable() export class Firebase extends IonicNativePlugin { /** * Get the device token * @return {Promise} Note that token will be null if it has not been established yet */ @Cordova() getToken(): Promise { return; } /** * Get notified when a token is refreshed * @return {Observable} */ @Cordova({ observable: true }) onTokenRefresh(): Observable { return; } /** * Get notified when the user opens a notification * @return {Observable} */ @Cordova({ observable: true }) onNotificationOpen(): Observable { return; } /** * Grant permission to receive push notifications * @return {Promise} */ @Cordova({ platforms: ['iOS'] }) grantPermission(): Promise { return; } /** * Check permission to receive push notifications * @return {Promise<{isEnabled: boolean}>} */ @Cordova() hasPermission(): Promise<{ isEnabled: boolean }> { return; } /** * Set icon badge number. Set to 0 to clear the badge. * @param {number} badgeNumber * @return {Promise} */ @Cordova() setBadgeNumber(badgeNumber: number): Promise { return; } /** * Get icon badge number * @return {Promise} */ @Cordova() getBadgeNumber(): Promise { return; } /** * Subscribe to a topic * @param {string} topic * @return {Promise} */ @Cordova() subscribe(topic: string): Promise { return; } /** * Unsubscribe from a topic * @param {string} topic * @return {Promise} */ @Cordova() unsubscribe(topic: string): Promise { return; } /** * Unregister from firebase, used to stop receiving push notifications. * Call this when you logout user from your app. */ @Cordova() unregister(): Promise { return; } /** * Log an event using Analytics * @param {string} type * @param {Object} data * @return {Promise} */ @Cordova() logEvent(type: string, data: any): Promise { return; } /** * Log an Error using FirebaseCrash * @param {string} message * @return {Promise} */ @Cordova() logError(message: string): Promise { return; } /** * Set the name of the current screen in Analytics * @param {string} name Screen name * @return {Promise} */ @Cordova() setScreenName(name: string): Promise { return; } /** * Set a user id for use in Analytics * @param {string} userId * @return {Promise} */ @Cordova() setUserId(userId: string): Promise { return; } /** * Set a user property for use in Analytics * @param {string} name * @param {string} value * @return {Promise} */ @Cordova() setUserProperty(name: string, value: string): Promise { return; } /** * Fetch Remote Config parameter values for your app * @param {number} [cacheExpirationSeconds] * @return {Promise} */ @Cordova({ successIndex: 1, errorIndex: 2 }) fetch(cacheExpirationSeconds?: number): Promise { return; } /** * Activate the Remote Config fetched config * @return {Promise} */ @Cordova() activateFetched(): Promise { return; } /** * Retrieve a Remote Config value * @param {string} key * @param {string} [namespace] * @return {Promise} */ @Cordova({ successIndex: 2, errorIndex: 3 }) getValue(key: string, namespace?: string): Promise { return; } /** * Retrieve a Remote Config byte array * @param {string} key * @param {string} [namespace] * @return {Promise} */ @Cordova({ platforms: ['Android'] }) getByteArray(key: string, namespace?: string): Promise { return; } /** * Get the current state of the FirebaseRemoteConfig singleton object * @return {Promise} */ @Cordova({ platforms: ['Android'] }) getInfo(): Promise { return; } /** * Change the settings for the FirebaseRemoteConfig object's operations * @param {Object} settings * @return {Promise} */ @Cordova({ platforms: ['Android'] }) setConfigSettings(settings: any): Promise { return; } /** * Set defaults in the Remote Config * @param {Object} defaults * @param {string} [namespace] * @return {Promise} */ @Cordova({ platforms: ['Android'] }) setDefaults(defaults: any, namespace?: string): Promise { return; } /** * Start a trace. * @param {string} trace Trace name */ @Cordova() startTrace(trace: string): Promise { return; } /** * To count the performance-related events that occur in your app (such as cache hits or retries), add a line of code * similar to the following whenever the event occurs, using a string other than retry to name that event if you are * counting a different type of event: * @param {string} trace Trace name * @param {string} counter Counter */ @Cordova() incrementCounter(trace: string, counter: string): Promise { return; } /** * Stop the trace * @param {string} trace Trace name */ @Cordova() stopTrace(trace: string): void {} /** * Allows the user to enable/disable analytics collection * @param {boolean} enabled value to set collection * @returns {Promise} */ @Cordova() setAnalyticsCollectionEnabled(enabled: boolean): Promise { return; } /** * Allows the user to set User Identifier for crashlytics reporting * https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#set_user_ids * @param {string} userId value to set the userId * @returns {Promise} */ @Cordova() setCrashlyticsUserId(userId: string): Promise { return; } /** * Sends an SMS to the user with the SMS verification code and returns the Verification ID required to sign in using phone authentication * @param {string} phoneNumber The phone number, including '+' and country code * @param {number} timeoutDuration (Android only) The timeout in sec - no more SMS will be sent to this number until this timeout expires * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'], successIndex: 2, errorIndex: 3 }) verifyPhoneNumber( phoneNumber: string, timeoutDuration = 0 ): Promise { return; } /** * Clear all pending notifications from the drawer * @return {Promise} */ clearAllNotifications(): Promise { return; } }