fix,docs(firebase): make 'namespace' param optional in setDefault; remove callback indexes; docs fix

Add optional label for optional parameters in docs
remove wrong callback indexes
make 'namespace' param optional in setDefault
This commit is contained in:
Vlado Velichkovski 2017-10-09 19:25:50 +02:00 committed by GitHub
parent ef28078815
commit 2c5aed9619

View File

@ -158,13 +158,10 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Fetch Remote Config parameter values for your app * Fetch Remote Config parameter values for your app
* @param cacheExpirationSeconds * @param cacheExpirationSeconds {number}
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova()
successIndex: 1,
errorIndex: 2
})
fetch(cacheExpirationSeconds?: number): Promise<any> { return; } fetch(cacheExpirationSeconds?: number): Promise<any> { return; }
/** /**
@ -177,25 +174,20 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Retrieve a Remote Config value * Retrieve a Remote Config value
* @param key {string} * @param key {string}
* @param namespace {string} * @param [namespace] {string}
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova()
successIndex: 2,
errorIndex: 3
})
getValue(key: string, namespace?: string): Promise<any> { return; } getValue(key: string, namespace?: string): Promise<any> { return; }
/** /**
* Retrieve a Remote Config byte array * Retrieve a Remote Config byte array
* @param key {string} * @param key {string}
* @param namespace {string} * @param [namespace] {string}
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
platforms: ['Android'], platforms: ['Android']
successIndex: 2,
errorIndex: 3
}) })
getByteArray(key: string, namespace?: string): Promise<any> { return; } getByteArray(key: string, namespace?: string): Promise<any> { return; }
@ -221,14 +213,12 @@ export class Firebase extends IonicNativePlugin {
/** /**
* Set defaults in the Remote Config * Set defaults in the Remote Config
* @param defaults {Object} * @param defaults {Object}
* @param namespace {string} * @param [namespace] {string}
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
platforms: ['Android'], platforms: ['Android']
successIndex: 2,
errorIndex: 3
}) })
setDefaults(defaults: any, namespace: string): Promise<any> { return; } setDefaults(defaults: any, namespace?: string): Promise<any> { return; }
} }