import { Plugin, Cordova } from './plugin'; 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 * ``` * import { Firebase } from 'ionic-native'; * * 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)); * * 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'] }) export class Firebase { /** * Get the device token * @return {Promise} */ @Cordova() static getToken(): Promise { return; } /** * Get notified when a token is refreshed * @return {Observable} */ @Cordova({ observable: true }) static onTokenRefresh(): Observable { return; } /** * Get notified when the user opens a notification * @return {Observable} */ @Cordova({ observable: true }) static onNotificationOpen(): Observable { return; } /** * Grant permission to recieve push notifications * @return {Promise} */ @Cordova({ platforms: ['iOS'] }) static grantPermission(): Promise { return; } /** * Set icon badge number. Set to 0 to clear the badge. * @param badgeNumber {number} * @return {Promise} */ @Cordova() static setBadgeNumber(badgeNumber: number): Promise { return; } /** * Get icon badge number * @return {Promise} */ @Cordova() static getBadgeNumber(): Promise { return; } /** * Subscribe to a topic * @param topic {string} * @return {Promise} */ @Cordova() static subscribe(topic: string): Promise { return; } /** * Unsubscribe from a topic * @param topic {string} * @return {Promise} */ @Cordova() static unsubscribe(topic: string): Promise { return; } /** * Log an event using Analytics * @param type {string} * @param data {Object} * @return {Promise} */ @Cordova() static logEvent(type: string, data: any): Promise { return; } /** * Set a user id for use in Analytics * @param userId {string} * @return {Promise} */ @Cordova() static setUserId(userId: string): Promise { return; } /** * Set a user property for use in Analytics * @param name {string} * @param value {string} * @return {Promise} */ @Cordova() static setUserProperty(name: string, value: string): Promise { return; } /** * Fetch Remote Config parameter values for your app * @param cacheExpirationSeconds * @return {Promise} */ @Cordova({ platforms: ['Android'], successIndex: 1, errorIndex: 2 }) static fetch(cacheExpirationSeconds?: number): Promise { return; } /** * Activate the Remote Config fetched config * @return {Promise} */ @Cordova({ platforms: ['Android'] }) static activateFetched(): Promise { return; } /** * Retrieve a Remote Config value * @param key {string} * @param namespace {string} * @return {Promise} */ @Cordova({ platforms: ['Android'], successIndex: 2, errorIndex: 3 }) static getValue(key: string, namespace?: string): Promise { return; } /** * Retrieve a Remote Config byte array * @param key {string} * @param namespace {string} * @return {Promise} */ @Cordova({ platforms: ['Android'], successIndex: 2, errorIndex: 3 }) static getByteArray(key: string, namespace?: string): Promise { return; } /** * Get the current state of the FirebaseRemoteConfig singleton object * @return {Promise} */ @Cordova({ platforms: ['Android'] }) static getInfo(): Promise { return; } /** * Change the settings for the FirebaseRemoteConfig object's operations * @param settings {Object} * @return {Promise} */ @Cordova({ platforms: ['Android'] }) static setConfigSettings(settings: any): Promise { return; } /** * Set defaults in the Remote Config * @param defaults {Object} * @param namespace {string} * @return {Promise} */ @Cordova({ platforms: ['Android'], successIndex: 2, errorIndex: 3 }) static setDefaults(defaults: any, namespace: string): Promise { return; } }