public/awesome-cordova-plugins
public/awesome-cordova-plugins
9
0
Fork 0
forked from github/awesome-cordova-plugins
Code Pull Requests Activity

docs(firebase): fix docs

Browse Source
This commit is contained in:
Daniel 2018-04-08 21:44:57 +02:00
parent 87f8505d93
commit 1cc7243ef9
1 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
src/@ionic-native/plugins/firebase/index.ts
View File

@ -1,5 +1,5 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core'; import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
import { Observable } from 'rxjs/Observable'; import { Observable } from 'rxjs/Observable';
/** /**
@ -30,7 +30,7 @@ import { Observable } from 'rxjs/Observable';
plugin: 'cordova-plugin-firebase', plugin: 'cordova-plugin-firebase',
pluginRef: 'FirebasePlugin', pluginRef: 'FirebasePlugin',
repo: 'https://github.com/arnesson/cordova-plugin-firebase', repo: 'https://github.com/arnesson/cordova-plugin-firebase',
platforms: ['Android', 'iOS'], platforms: ['Android', 'iOS']
}) })
@Injectable() @Injectable()
export class Firebase extends IonicNativePlugin { export class Firebase extends IonicNativePlugin {
@ -87,7 +87,7 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Set icon badge number. Set to 0 to clear the badge. * Set icon badge number. Set to 0 to clear the badge.
* @param badgeNumber {number} * @param {number} badgeNumber
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova() @Cordova()
@ -106,7 +106,7 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Subscribe to a topic * Subscribe to a topic
* @param topic {string} * @param {string} topic
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova() @Cordova()
@ -116,7 +116,7 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Unsubscribe from a topic * Unsubscribe from a topic
* @param topic {string} * @param {string} topic
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova() @Cordova()
@ -135,8 +135,8 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Log an event using Analytics * Log an event using Analytics
* @param type {string} * @param {string} type
* @param data {Object} * @param {Object} data
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova() @Cordova()
@ -146,7 +146,7 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Log an Error using FirebaseCrash * Log an Error using FirebaseCrash
* @param message {string} * @param {string} message
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova() @Cordova()
@ -156,7 +156,7 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Set the name of the current screen in Analytics * Set the name of the current screen in Analytics
* @param name {string} Screen name * @param {string} name Screen name
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova() @Cordova()
@ -166,7 +166,7 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Set a user id for use in Analytics * Set a user id for use in Analytics
* @param userId {string} * @param {string} userId
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova() @Cordova()
@ -176,8 +176,8 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Set a user property for use in Analytics * Set a user property for use in Analytics
* @param name {string} * @param {string} name
* @param value {string} * @param {string} value
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova() @Cordova()
@ -187,7 +187,7 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Fetch Remote Config parameter values for your app * Fetch Remote Config parameter values for your app
* @param cacheExpirationSeconds {number} * @param {number} [cacheExpirationSeconds]
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -209,8 +209,8 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Retrieve a Remote Config value * Retrieve a Remote Config value
* @param key {string} * @param {string} key
* @param [namespace] {string} * @param {string} [namespace]
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -223,8 +223,8 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Retrieve a Remote Config byte array * Retrieve a Remote Config byte array
* @param key {string} * @param {string} key
* @param [namespace] {string} * @param {string} [namespace]
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -247,7 +247,7 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Change the settings for the FirebaseRemoteConfig object's operations * Change the settings for the FirebaseRemoteConfig object's operations
* @param settings {Object} * @param {Object} settings
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -259,8 +259,8 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Set defaults in the Remote Config * Set defaults in the Remote Config
* @param defaults {Object} * @param {Object} defaults
* @param [namespace] {string} * @param {string} [namespace]
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -272,7 +272,7 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Sends an SMS to the user with the SMS verification code and returns the Verification ID required to sign in using phone authentication * Sends an SMS to the user with the SMS verification code and returns the Verification ID required to sign in using phone authentication
* @param phoneNumber {string} * @param {string} phoneNumber
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -284,8 +284,8 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Sends an SMS to the user with the SMS verification code and returns the Verification ID required to sign in using phone authentication * Sends an SMS to the user with the SMS verification code and returns the Verification ID required to sign in using phone authentication
* @param phoneNumber {string} the phone number, including '+' and country code * @param {string} phoneNumber The phone number, including '+' and country code
* @param timeoutDuration {number} the timeout in sec - no more SMS will be sent to this number until this timeout expires * @param {number} timeoutDuration The timeout in sec - no more SMS will be sent to this number until this timeout expires
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -293,13 +293,16 @@ export class Firebase extends IonicNativePlugin {
successIndex: 2, successIndex: 2,
errorIndex: 3 errorIndex: 3
}) })
verifyPhoneNumber(phoneNumber: string, timeoutDuration: number): Promise<any> { verifyPhoneNumber(
phoneNumber: string,
timeoutDuration: number
): Promise<any> {
return; return;
} }
/** /**
* Allows the user to enable/disable analytics collection * Allows the user to enable/disable analytics collection
* @param enabled {booleab} value to set collection * @param {boolean} enabled value to set collection
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()