feat(firebase): add new Firebase phone verification methods (#2157)

* feat(firebase): add missing method

* feat(firebase): add missing ios method

* Update index.ts
This commit is contained in:
Nik Martin 2017-12-01 22:04:54 -06:00 committed by Ibby Hadeed
parent 784f948a5b
commit 86181afc27

View File

@ -30,17 +30,18 @@ import { Observable } from 'rxjs/Observable';
plugin: 'cordova-plugin-firebase',
pluginRef: 'FirebasePlugin',
repo: 'https://github.com/arnesson/cordova-plugin-firebase',
platforms: ['Android', 'iOS']
platforms: ['Android', 'iOS'],
})
@Injectable()
export class Firebase extends IonicNativePlugin {
/**
* Get the device token
* @return {Promise<any>}
*/
@Cordova()
getToken(): Promise<any> { return; }
getToken(): Promise<any> {
return;
}
/**
* Get notified when a token is refreshed
@ -49,7 +50,9 @@ export class Firebase extends IonicNativePlugin {
@Cordova({
observable: true
})
onTokenRefresh(): Observable<any> { return; }
onTokenRefresh(): Observable<any> {
return;
}
/**
* Get notified when the user opens a notification
@ -58,7 +61,9 @@ export class Firebase extends IonicNativePlugin {
@Cordova({
observable: true
})
onNotificationOpen(): Observable<any> { return; }
onNotificationOpen(): Observable<any> {
return;
}
/**
* Grant permission to receive push notifications
@ -67,14 +72,18 @@ export class Firebase extends IonicNativePlugin {
@Cordova({
platforms: ['iOS']
})
grantPermission(): Promise<any> { return; }
grantPermission(): Promise<any> {
return;
}
/**
* Check permission to receive push notifications
* @return {Promise<{isEnabled: boolean}>}
*/
* Check permission to receive push notifications
* @return {Promise<{isEnabled: boolean}>}
*/
@Cordova()
hasPermission(): Promise<{isEnabled: boolean}> { return; }
hasPermission(): Promise<{ isEnabled: boolean }> {
return;
}
/**
* Set icon badge number. Set to 0 to clear the badge.
@ -82,14 +91,18 @@ export class Firebase extends IonicNativePlugin {
* @return {Promise<any>}
*/
@Cordova()
setBadgeNumber(badgeNumber: number): Promise<any> { return; }
setBadgeNumber(badgeNumber: number): Promise<any> {
return;
}
/**
* Get icon badge number
* @return {Promise<any>}
*/
@Cordova()
getBadgeNumber(): Promise<any> { return; }
getBadgeNumber(): Promise<any> {
return;
}
/**
* Subscribe to a topic
@ -97,7 +110,9 @@ export class Firebase extends IonicNativePlugin {
* @return {Promise<any>}
*/
@Cordova()
subscribe(topic: string): Promise<any> { return; }
subscribe(topic: string): Promise<any> {
return;
}
/**
* Unsubscribe from a topic
@ -105,14 +120,18 @@ export class Firebase extends IonicNativePlugin {
* @return {Promise<any>}
*/
@Cordova()
unsubscribe(topic: string): Promise<any> { return; }
unsubscribe(topic: string): Promise<any> {
return;
}
/**
* Unregister from firebase, used to stop receiving push notifications.
* Call this when you logout user from your app.
*/
@Cordova()
unregister(): Promise<any> { return; }
unregister(): Promise<any> {
return;
}
/**
* Log an event using Analytics
@ -121,7 +140,9 @@ export class Firebase extends IonicNativePlugin {
* @return {Promise<any>}
*/
@Cordova()
logEvent(type: string, data: any): Promise<any> { return; }
logEvent(type: string, data: any): Promise<any> {
return;
}
/**
* Log an Error using FirebaseCrash
@ -129,7 +150,9 @@ export class Firebase extends IonicNativePlugin {
* @return {Promise<any>}
*/
@Cordova()
logError(message: string): Promise<any> { return; }
logError(message: string): Promise<any> {
return;
}
/**
* Set the name of the current screen in Analytics
@ -137,7 +160,9 @@ export class Firebase extends IonicNativePlugin {
* @return {Promise<any>}
*/
@Cordova()
setScreenName(name: string): Promise<any> { return; }
setScreenName(name: string): Promise<any> {
return;
}
/**
* Set a user id for use in Analytics
@ -145,7 +170,9 @@ export class Firebase extends IonicNativePlugin {
* @return {Promise<any>}
*/
@Cordova()
setUserId(userId: string): Promise<any> { return; }
setUserId(userId: string): Promise<any> {
return;
}
/**
* Set a user property for use in Analytics
@ -154,7 +181,9 @@ export class Firebase extends IonicNativePlugin {
* @return {Promise<any>}
*/
@Cordova()
setUserProperty(name: string, value: string): Promise<any> { return; }
setUserProperty(name: string, value: string): Promise<any> {
return;
}
/**
* Fetch Remote Config parameter values for your app
@ -165,14 +194,18 @@ export class Firebase extends IonicNativePlugin {
successIndex: 1,
errorIndex: 2
})
fetch(cacheExpirationSeconds?: number): Promise<any> { return; }
fetch(cacheExpirationSeconds?: number): Promise<any> {
return;
}
/**
* Activate the Remote Config fetched config
* @return {Promise<any>}
*/
@Cordova()
activateFetched(): Promise<any> { return; }
activateFetched(): Promise<any> {
return;
}
/**
* Retrieve a Remote Config value
@ -184,7 +217,9 @@ export class Firebase extends IonicNativePlugin {
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
@ -197,7 +232,9 @@ export class Firebase extends IonicNativePlugin {
successIndex: 2,
errorIndex: 3
})
getByteArray(key: string, namespace?: string): Promise<any> { return; }
getByteArray(key: string, namespace?: string): Promise<any> {
return;
}
/**
* Get the current state of the FirebaseRemoteConfig singleton object
@ -206,7 +243,9 @@ export class Firebase extends IonicNativePlugin {
@Cordova({
platforms: ['Android']
})
getInfo(): Promise<any> { return; }
getInfo(): Promise<any> {
return;
}
/**
* Change the settings for the FirebaseRemoteConfig object's operations
@ -216,7 +255,9 @@ export class Firebase extends IonicNativePlugin {
@Cordova({
platforms: ['Android']
})
setConfigSettings(settings: any): Promise<any> { return; }
setConfigSettings(settings: any): Promise<any> {
return;
}
/**
* Set defaults in the Remote Config
@ -229,6 +270,34 @@ export class Firebase extends IonicNativePlugin {
successIndex: 2,
errorIndex: 3
})
setDefaults(defaults: any, namespace: string): Promise<any> { return; }
setDefaults(defaults: any, namespace: string): Promise<any> {
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 phoneNumber {string}
* @returns {Promise<any>}
*/
@Cordova({
platforms: ['iOS']
})
getVerificationID(phoneNumber: string): Promise<any> {
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 phoneNumber {string} 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
* @returns {Promise<any>}
*/
@Cordova({
platforms: ['Android'],
successIndex: 2,
errorIndex: 3
})
verifyPhoneNumber(phoneNumber: string, timeoutDuration: number): Promise<any> {
return;
}
}