+ 
+
+ 
+
Data payload: `onMessageReceived` via extras of New Intent[[2]](#messagetypefootnote2) | +| Not running | System tray[[1]](#messagetypefootnote1) | **Never received**[[3]](#messagetypefootnote3) | Notification payload: System tray[[1]](#messagetypefootnote1)
Data payload: `onMessageReceived` via extras of Launch Intent[[2]](#messagetypefootnote2) | + +1: If user taps the system notification, its payload is delivered to `onMessageReceived` + +2: The data payload is only delivered as an extras Bundle Intent if the user taps the system notification. +Otherwise it will not be delivered as outlined in [this Firebase documentation](https://firebase.google.com/docs/cloud-messaging/concept-options#notification-messages-with-optional-data-payload). + +3: If the app is not running/has been task-killed when the data message arrives, it will never be received by the app. + +## iOS notifications + +Notifications on iOS can be customised to specify the sound and badge number that's displayed when the notification arrives. + +Notification settings are specified in the `apns.payload.aps` key of the notification message payload. +For example: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "apns": { + "payload": { + "aps": { + "sound": "default", + "badge": 1, + "content-available": 1 + } + } + } +} +``` + +### iOS background notifications + +If the notification message arrives while the app is in the background/not running, it will be displayed as a system notification. + +If the user then taps the system notification, the app will be brought to the foreground and `onMessageReceived` will be invoked **again**, this time with `tap: "background"` indicating that the user tapped the system notification while the app was in the background. + +If the app is in the background or inactive when the notification message arrives, the message can be queued so that the next time the app is resumed from the background, the `onMessageReceived` callback is invoked with the notification payload without requiring user interaction (i.e. tapping the system notification). +To do this you must specify `"content-available": 1` in the `apns.payload.aps` section of the message payload - see the [Apple documentation](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW8) for more information. +When app is next launched/resumed from the background, any queued notification payloads will be sent to the `onMessageReceived` callback without the `tap` property, indicating the message was received without user interaction. + +If you wish to attempt to immediately deliver the message payload to the `onMessageReceived` callback when the app is in the background or inactive (the default behaviour of this plugin prior to v18), you can set the `FIREBASE_MESSAGING_IMMEDIATE_PAYLOAD_DELIVERY` plugin variable to `true` at plugin install time: + + cordova plugin add cordova-plugin-firebasex --variable FIREBASE_MESSAGING_IMMEDIATE_PAYLOAD_DELIVERY=true + +However there is no guarantee that the message will be delivered successfully, since the Cordova application running in the Webview may not be in a state where it can receive the notification message. + +### iOS notification sound + +You can specify custom sounds for notifications or play the device default notification sound. + +Custom sound files must be in a supported audio format (see [this Apple documentation](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/SupportingNotificationsinYourApp.html#//apple_ref/doc/uid/TP40008194-CH4-SW10) for supported formats). +For example to convert an `.mp3` file to the supported `.caf` format run: + + afconvert my_sound.mp3 my_sound.caf -d ima4 -f caff -v + +Sound files must be deployed with the iOS application bundle. +To do this, you can add `
+
+
+To use them in your app you must do the following:
+
+1. Add a `pn-actions.json` file to your Cordova project which defines categories and actions, for example:
+
+```json
+{
+ "PushNotificationActions": [
+ {
+ "category": "news",
+ "actions": [
+ {
+ "id": "read",
+ "title": "Read",
+ "foreground": true
+ },
+ {
+ "id": "skip",
+ "title": "Skip"
+ },
+ {
+ "id": "delete",
+ "title": "Delete",
+ "destructive": true
+ }
+ ]
+ }
+ ]
+}
+```
+
+Note the `foreground` and `destructive` options correspond to the equivalent [UNNotificationActionOptions](https://developer.apple.com/documentation/usernotifications/unnotificationactionoptions?language=objc).
+
+2. Reference it as a resource file in your `config.xml`:
+
+```xml
+ 
+
+Adding such a Button is possible with this Plugin.
+To enable this Feature, you need to pass `true` for **requestWithProvidesAppNotificationSettings** when you [request the Permission](#grantpermission).
+
+You then need to subscribe to `onOpenSettings` and open your apps notification settings page.
+
+## Data messages
+
+FCM data messages are sent as an arbitrary k/v structure and by default are passed to the app for it to handle them.
+
+**NOTE:** FCM data messages **cannot** be sent from the Firebase Console - they can only be sent via the FCM APIs.
+
+### Data message notifications
+
+This plugin enables a data message to be displayed as a system notification.
+To have the app display a notification when the data message arrives, you need to set the `notification_foreground` key in the `data` section.
+You can then set a `notification_title` and `notification_body`, for example:
+
+```json
+{
+ "name": "my_data",
+ "data": {
+ "notification_foreground": "true",
+ "notification_body": "Notification body",
+ "notification_title": "Notification title",
+ "foo": "bar"
+ }
+}
+```
+
+Additional platform-specific notification options can be set using the additional keys below (which are only relevant if the `notification_foreground` key is set).
+
+Note: [foreground notification messages](#foreground-notifications) can also make use of these keys.
+
+#### Android data message notifications
+
+On Android:
+
+- Data messages that arrive while your app is running in the foreground or running in the background will be immediately passed to the `onMessageReceived()` Javascript handler in the Webview.
+- Data messages (not containing notification keys) that arrive while your app is **not running** will be passed to the `onMessageReceived()` Javascript handler when the app is next launched.
+- Data messages containing notification keys that arrive while your app is running or **not running** will be displayed as a system notification.
+
+The following Android-specific keys are supported and should be placed inside the `data` section:
+
+- `notification_android_id` - Identifier used to replace existing notifications in the notification drawer
+ - If not specified, each request creates a new notification.
+ - If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer.
+- `notification_android_body_html` - If is passed, the body of a notification is processed as if it were html, you can use `, or +Android +
+
+
++iOS +
+
+
+## Authentication
+
+### isUserSignedIn
+
+Checks if there is a current Firebase user signed into the app.
+
+**Parameters**:
+
+- {function} success - callback function to pass {boolean} result to as an argument
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.isUserSignedIn(
+ function (isSignedIn) {
+ console.log("User " + (isSignedIn ? "is" : "is not") + " signed in");
+ },
+ function (error) {
+ console.error("Failed to check if user is signed in: " + error);
+ }
+);
+```
+
+### signOutUser
+
+Signs current Firebase user out of the app.
+
+**Parameters**:
+
+- {function} success - callback function to pass {boolean} result to as an argument
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.signOutUser(
+ function () {
+ console.log("User signed out");
+ },
+ function (error) {
+ console.error("Failed to sign out user: " + error);
+ }
+);
+```
+
+### getCurrentUser
+
+Returns details of the currently logged in user from local Firebase SDK.
+Note that some user properties will be empty is they are not defined in Firebase for the current user.
+
+**Parameters**:
+
+- {function} success - callback function to pass user {object} to as an argument
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.getCurrentUser(
+ function (user) {
+ console.log("Name: " + user.name);
+ console.log("Email: " + user.email);
+ console.log("Is email verified?: " + user.emailIsVerified);
+ console.log("Phone number: " + user.phoneNumber);
+ console.log("Photo URL: " + user.photoUrl);
+ console.log("UID: " + user.uid);
+ console.log("Provider ID: " + user.providerId);
+ console.log("ID token: " + user.idToken);
+ console.log("creationTime", user.creationTimestamp);
+ console.log("lastSignInTime", user.lastSignInTimestamp);
+
+ for (var i = 0; i < user.providers.length; i++) {
+ console.log("providerId", user.providers[i].providerId);
+ console.log("uid", user.providers[i].uid);
+ console.log("displayName", user.providers[i].displayName);
+ console.log("email", user.providers[i].email);
+ console.log("phoneNumber", user.providers[i].phoneNumber);
+ console.log("photoUrl", user.providers[i].photoUrl);
+ }
+ },
+ function (error) {
+ console.error("Failed to get current user data: " + error);
+ }
+);
+```
+
+### reloadCurrentUser
+
+Loads details of the currently logged in user from remote Firebase server.
+This differs from `getCurrentUser()` which loads the locally cached details which may be stale.
+For example, if you want to check if a user has verified their email address, this method will guarantee the reported verified state is up-to-date.
+
+**Parameters**:
+
+- {function} success - callback function to pass user {object} to as an argument
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.reloadCurrentUser(
+ function (user) {
+ console.log("Name: " + user.name);
+ console.log("Email: " + user.email);
+ console.log("Is email verified?: " + user.emailIsVerified);
+ console.log("Phone number: " + user.phoneNumber);
+ console.log("Photo URL: " + user.photoUrl);
+ console.log("UID: " + user.uid);
+ console.log("Provider ID: " + user.providerId);
+ console.log("ID token: " + user.idToken);
+ },
+ function (error) {
+ console.error("Failed to reload current user data: " + error);
+ }
+);
+```
+
+### updateUserProfile
+
+Updates the display name and/or photo URL of the current Firebase user signed into the app.
+
+**Parameters**:
+
+- {object} profile - new profile details:
+ - {string} name - display name of user
+ - {string} photoUri - URL of user profile photo
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.updateUserProfile(
+ {
+ name: "Homer Simpson",
+ photoUri: "http://homer.simpson.com/photo.png",
+ },
+ function () {
+ console.log("User profile successfully updated");
+ },
+ function (error) {
+ console.error("Failed to update user profile: " + error);
+ }
+);
+```
+
+### updateUserEmail
+
+Updates/sets the email address of the current Firebase user signed in to the app.
+
+**Parameters**:
+
+- {string} email - email address of user to set as current
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.updateUserEmail(
+ "user@somewhere.com",
+ function () {
+ console.log("User email successfully updated");
+ },
+ function (error) {
+ console.error("Failed to update user email: " + error);
+ }
+);
+```
+
+### sendUserEmailVerification
+
+Sends a verification email to the currently configured email address of the current Firebase user signed into the app.
+When the user opens the contained link, their email address will have been verified.
+
+**Parameters**:
+
+- {object} actionCodeSettings - action code settings based on [Passing State in Email Actions Parameters](https://firebase.google.com/docs/auth/web/passing-state-in-email-actions#passing_statecontinue_url_in_email_actions) :
+ - {boolean} handleCodeInApp - Whether the email action link will be opened in a mobile app or a web link first
+ - {string} url - Continue URL after email has been verified
+ - {string} dynamicLinkDomain - Sets the dynamic link domain to use for the current link if it is to be opened using Firebase Dynamic Links
+ - {string} iosBundleId - Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed
+ - {string} androidPackageName - Sets the Android package name. This will try to open the link in an android app if it is installed
+ - {boolean} installIfNotAvailable - Install if the provided app package name is not already installed on the users device (Android only)
+ - {string} minimumVersion - minimum app version required (Android Only)
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.sendUserEmailVerification(
+ {
+ handleCodeInApp: true,
+ url: "http://www.example.com",
+ dynamicLinkDomain: "example.page.link",
+ iosBundleId: "com.example.ios",
+ androidPackageName: "com.example.android",
+ installIfNotAvailable: true,
+ minimumVersion: "12",
+ },
+ function () {
+ console.log("User verification email successfully sent");
+ },
+ function (error) {
+ console.error("Failed to send user verification email: " + error);
+ }
+);
+```
+
+### verifyBeforeUpdateEmail
+
+First verifies the user's identity, then set/supdates the email address of the current Firebase user signed in to the app.
+
+- This is required when a user with multi-factor authentication enabled on their account wishes to change their registered email address.
+ - [updateUserEmail](#updateuseremail) cannot be used and will result in an error.
+- See [the Firebase documentation](https://cloud.google.com/identity-platform/docs/work-with-mfa-users#updating_a_users_email) regarding updating the email address of a user with multi-factor authentication enabled.
+
+**Parameters**:
+
+- {string} email - email address of user to set as current
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.verifyBeforeUpdateEmail(
+ "user@somewhere.com",
+ function () {
+ console.log("User verified and email successfully updated");
+ },
+ function (error) {
+ console.error("Failed to verify user/update user email: " + error);
+ }
+);
+```
+
+### updateUserPassword
+
+Updates/sets the account password for the current Firebase user signed into the app.
+
+**Parameters**:
+
+- {string} password - user-defined password
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.updateUserPassword(
+ "mypassword",
+ function () {
+ console.log("User password successfully updated");
+ },
+ function (error) {
+ console.error("Failed to update user password: " + error);
+ }
+);
+```
+
+### sendUserPasswordResetEmail
+
+Sends a password reset email to the specified user email address.
+Note: doesn't require the Firebase user to be signed in to the app.
+
+**Parameters**:
+
+- {string} email - email address of user
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.sendUserPasswordResetEmail(
+ "user@somewhere.com",
+ function () {
+ console.log("User password reset email sent successfully");
+ },
+ function (error) {
+ console.error("Failed to send user password reset email: " + error);
+ }
+);
+```
+
+### deleteUser
+
+Deletes the account of the current Firebase user signed into the app.
+
+**Parameters**:
+
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+```javascript
+FirebasePlugin.deleteUser(
+ function () {
+ console.log("User account deleted");
+ },
+ function (error) {
+ console.error("Failed to delete current user account: " + error);
+ }
+);
+```
+
+### createUserWithEmailAndPassword
+
+Creates a new email/password-based user account.
+If account creation is successful, user will be automatically signed in.
+
+**Parameters**:
+
+- {string} email - user email address. It is the responsibility of the app to ensure this is a valid email address.
+- {string} password - user password. It is the responsibility of the app to ensure the password is suitable.
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument.
+ - If the error is due to the user account requiring multi-factor authentication, a second {array} argument will be passed containing a list of enrolled factors.
+ - A factor should be selected and used for second factor verification - see [verifySecondAuthFactor](#verifysecondauthfactor) for more on this.
+
+Example usage:
+
+```javascript
+FirebasePlugin.createUserWithEmailAndPassword(
+ email,
+ password,
+ function () {
+ console.log("Successfully created email/password-based user account");
+ // User is now signed in
+ },
+ function (error, secondFactors) {
+ if (
+ error === "Second factor required" &&
+ typeof secondFactors !== "undefined"
+ ) {
+ handleSecondFactorAuthentation(secondFactors); // you need to implement this
+ } else {
+ console.error(
+ "Failed to create email/password-based user account",
+ error
+ );
+ }
+ }
+);
+```
+
+### signInUserWithEmailAndPassword
+
+Signs in to an email/password-based user account.
+
+**Parameters**:
+
+- {string} email - user email address
+- {string} password - user password
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+ - If the error is due to the user account requiring multi-factor authentication, a second {array} argument will be passed containing a list of enrolled factors. - A factor should be selected and used for second factor verification - see [verifySecondAuthFactor](#verifysecondauthfactor) for more on this.
+
+Example usage:
+
+```javascript
+FirebasePlugin.signInUserWithEmailAndPassword(
+ email,
+ password,
+ function () {
+ console.log("Successfully signed in");
+ // User is now signed in
+ },
+ function (error, secondFactors) {
+ if (
+ error === "Second factor required" &&
+ typeof secondFactors !== "undefined"
+ ) {
+ handleSecondFactorAuthentation(secondFactors); // you need to implement this
+ } else {
+ console.error("Failed to sign in", error);
+ }
+ }
+);
+```
+
+### signInUserWithCustomToken
+
+Signs in user with custom token.
+
+**Parameters**:
+
+- {string} customToken - the custom token
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+ - If the error is due to the user account requiring multi-factor authentication, a second {array} argument will be passed containing a list of enrolled factors. - A factor should be selected and used for second factor verification - see [verifySecondAuthFactor](#verifysecondauthfactor) for more on this.
+
+Example usage:
+
+```javascript
+FirebasePlugin.signInUserWithCustomToken(
+ customToken,
+ function () {
+ console.log("Successfully signed in");
+ // User is now signed in
+ },
+ function (error, secondFactors) {
+ if (
+ error === "Second factor required" &&
+ typeof secondFactors !== "undefined"
+ ) {
+ handleSecondFactorAuthentation(secondFactors); // you need to implement this
+ } else {
+ console.error("Failed to sign in", error);
+ }
+ }
+);
+```
+
+### signInUserAnonymously
+
+Signs in user anonymously.
+
+**Parameters**:
+
+- {function} success - callback function to call on success
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+Example usage:
+
+```javascript
+FirebasePlugin.signInUserAnonymously(
+ function () {
+ console.log("Successfully signed in");
+ // User is now signed in
+ },
+ function (error) {
+ console.error("Failed to sign in", error);
+ }
+);
+```
+
+### verifyPhoneNumber
+
+Requests verification of a phone number.
+The resulting credential can be used to create/sign in to a phone number-based user account in your app or to link the phone number to an existing user account
+
+**NOTE: This will only work on physical devices with a SIM card (not iOS Simulator or Android Emulator)**
+
+In response to your request, you'll receive a verification ID which you can use in conjunction with the verification code to sign the user in.
+
+There are 3 verification scenarios:
+
+- Some Android devices support "instant verification" where the phone number can be instantly verified without sending or receiving an SMS.
+ - In this case, the user doesn't need to do anything in order for you to sign them in and you don't need to provide any additional credentials in order to sign the user in or link the user account to an existing Firebase user account.
+- Some Android devices support "auto-retrieval" where Google Play services is able to detect the incoming verification SMS and perform verification with no user action required.
+ - As above, the user doesn't need to do anything in order for you to sign them in.
+- For other Android devices and all iOS devices, the user must manually enter the verification code received in the SMS into your app.
+ - This code be used, along with the accompanying verification ID, to sign the user in or link phone number to an existing Firebase user account.
+
+**Parameters**:
+
+- {function} success - callback function to pass {object} credentials to as an argument
+- {function} error - callback function which will be passed a {string} error message as an argument
+- {string} phoneNumber - phone number to verify
+- {object} opts - (optional) parameters
+ - {integer} timeOutDuration - (Android only) time to wait in seconds before timing out. Defaults to 30 seconds if not specified.
+ - {boolean} requireSmsValidation - (Android only) whether to always require SMS validation on Android even if instant verification is available. Defaults to false if not specified.
+ - {string} fakeVerificationCode - (Android only) to test instant verification on Android, specify a fake verification code to return for whitelisted phone numbers.
+ - See [Firebase SDK Phone Auth Android Integration Testing](https://firebase.google.com/docs/auth/android/phone-auth#integration-testing) for more info.
+
+The success callback will be passed a credential object with the following possible properties:
+
+- {boolean} instantVerification - `true` if the Android device used instant verification to instantly verify the user without sending an SMS
+ or used auto-retrieval to automatically read an incoming SMS.
+ If this is `false`, the device will be sent an SMS containing the verification code.
+ If the Android device supports auto-retrieval, on the device receiving the SMS, this success callback will be immediately invoked again with `instantVerification: true` and no user action will be required for verification since Google Play services will extract and submit the verification code.
+ Otherwise the user must manually enter the verification code from the SMS into your app.
+ Always `false` on iOS.
+- {string} id - the identifier of a native credential object which can be used for signing in the user.
+ Will only be present if `instantVerification` is `true`.
+- {string} verificationId - the verification ID to be passed along with the verification code sent via SMS to sign the user in.
+ Will only be present if `instantVerification` is `false`.
+
+Example usage:
+
+```javascript
+var number = "+441234567890";
+var timeOutDuration = 60;
+var fakeVerificationCode = "123456";
+var awaitingSms = false;
+
+FirebasePlugin.verifyPhoneNumber(
+ function (credential) {
+ if (credential.instantVerification) {
+ if (awaitingSms) {
+ awaitingSms = false;
+ // the Android device used auto-retrieval to extract and submit the verification code in the SMS so dismiss user input UI
+ dismissUserPromptToInputCode();
+ }
+ signInWithCredential(credential);
+ } else {
+ awaitingSms = true;
+ promptUserToInputCode() // you need to implement this
+ .then(function (userEnteredCode) {
+ awaitingSms = false;
+ credential.code = userEnteredCode; // set the user-entered verification code on the credential object
+ signInWithCredential(credential);
+ });
+ }
+ },
+ function (error) {
+ console.error(
+ "Failed to verify phone number: " + JSON.stringify(error)
+ );
+ },
+ number,
+ {
+ timeOutDuration: timeOutDuration,
+ requireSmsValidation: false,
+ fakeVerificationCode: fakeVerificationCode,
+ }
+);
+
+function signInWithCredential(credential) {
+ FirebasePlugin.signInWithCredential(
+ credential,
+ function () {
+ console.log("Successfully signed in");
+ },
+ function (error) {
+ console.error("Failed to sign in", error);
+ }
+ );
+}
+```
+
+#### Android
+
+To use phone auth with your Android app, you need to configure your app SHA-1 hash in the android app configuration in the Firebase console.
+See [this guide](https://developers.google.com/android/guides/client-auth) to find how to your SHA-1 app hash.
+See the [Firebase phone auth integration guide for native Android](https://firebase.google.com/docs/auth/android/phone-auth) for more information.
+
+#### iOS
+
+When you call this method on iOS, FCM sends a silent push notification to the iOS device to verify it.
+So to use phone auth with your iOS app, you need to:
+
+- [setup your iOS app for push notifications](https://firebase.google.com/docs/cloud-messaging/ios/certs)
+- Verify that push notifications are arriving on your physical device
+- [Upload your APNs auth key to the Firebase console](https://firebase.google.com/docs/cloud-messaging/ios/client#upload_your_apns_authentication_key).
+
+You can [set up reCAPTCHA verification for iOS](https://firebase.google.com/docs/auth/ios/phone-auth#set-up-recaptcha-verification) automatically by specifying the `SETUP_RECAPTCHA_VERIFICATION` plugin variable at plugin install time:
+
+ cordova plugin add cordova-plugin-firebasex --variable SETUP_RECAPTCHA_VERIFICATION=true
+
+This adds the `REVERSED_CLIENT_ID` from the `GoogleService-Info.plist` to the list of custom URL schemes in your Xcode project, so you don't need to do this manually.
+
+### enrollSecondAuthFactor
+
+Enrolls a user-specified phone number as a second factor for multi-factor authentication (MFA).
+
+- As with [verifyPhoneNumber](#verifyphonenumber), this may require the user to manually input the verification code received in an SMS message.
+ - In this case, once the user has entered the code, `enrollSecondAuthFactor` will need to be called again with the `credential` option used to specified the `code` and verification `id`.
+- This function involves a similar verification flow to [verifyPhoneNumber](#verifyphonenumber) and therefore has the same pre-requisites and requirements.
+- See the Firebase MFA documentation for [Android](https://cloud.google.com/identity-platform/docs/android/mfa) and [iOS](https://cloud.google.com/identity-platform/docs/ios/mfa) for more information on MFA-specific setup requirements.
+- Calling when no user is signed in will result in error callback being invoked.
+
+**Parameters**:
+
+- {function} success - callback function to invoke either upon:
+ - successful enrollment: will be passed `true` as an argument
+ - user-entered verification code required: will be passed a `credential` object with a verification `id`.
+- {function} error - callback function which will be passed a {string} error message as an argument
+- {string} phoneNumber - phone number to enroll
+- {object} opts - (optional) parameters
+ - {string} displayName - display name for second factor.
+ - Used when a user has multiple second factor phone numbers enrolled and asking them which to use since the full phone number is masked.
+ - If not specified, defaults to the masked phone number.
+ - {object} credential - if manual entry of the verification code in an SMS is required, the `credential` object will be passed to the `success` function. The user-entered code should be appended to this object as the `code` property then this function re-invoked with the `credential` specified in the `opts` argument.
+ - {integer} timeOutDuration - (Android only) time to wait in seconds before timing out. Defaults to 30 seconds if not specified.
+ - {boolean} requireSmsValidation - (Android only) whether to always require SMS validation on Android even if instant verification is available. Defaults to false if not specified.
+ - {string} fakeVerificationCode - (Android only) to test instant verification on Android, specify a fake verification code to return for whitelisted phone numbers.
+ - See [Firebase SDK Phone Auth Android Integration Testing](https://firebase.google.com/docs/auth/android/phone-auth#integration-testing) for more info.
+
+Example usage:
+
+```javascript
+var phoneNumber = "+441234567890";
+var timeOutDuration = 60;
+var fakeVerificationCode = "123456";
+var displayName = "Work phone";
+var credential;
+
+function enrollSecondAuthFactor() {
+ FirebasePlugin.enrollSecondAuthFactor(
+ function (result) {
+ if (typeof result === "object") {
+ // User must enter SMS verification code manually
+ credential = result;
+ promptUserToInputCode() // you need to implement this
+ .then(function (userEnteredCode) {
+ credential.code = userEnteredCode; // set the user-entered verification code on the credential object
+ enrollSecondAuthFactor(); // re-invoke the function with the credential
+ });
+ } else {
+ console.log("Second factor successfully enrolled");
+ }
+ },
+ function (error) {
+ console.error(
+ "Failed to enroll second factor: " + JSON.stringify(error)
+ );
+ },
+ phoneNumber,
+ {
+ displayName: displayName,
+ credential: credential,
+ timeOutDuration: timeOutDuration,
+ requireSmsValidation: false,
+ fakeVerificationCode: fakeVerificationCode,
+ }
+ );
+}
+enrollSecondAuthFactor();
+```
+
+### verifySecondAuthFactor
+
+Verifies a second factor phone number for multi-factor authentication (MFA).
+
+- If a user has MFA enrolled on their account, when they try to perform an authentication operation, such as sign-in using one of the first factor methods (e.g. [signInUserWithEmailAndPassword](#signinuserwithemailandpassword)), the error callback of that function will be invoked.
+ - The first argument passed to the error callback will be the error message: "Second factor required"
+ - A second argument will be passed containing the list of (one or more) enrolled second factors for that user; each factor in the list will be an object with the following properties:
+ - {integer} index - index of the factor in the list - specify this as `selectedIndex` to select this factor.
+ - {string} displayName - name of factor specified by the user when this factor was enrolled.
+ - If no name was specified during enrollment, defaults to the masked phone number.
+ - {string} phoneNumber - phone number for this factor.
+- The app should then call this function, specifying the `selectedIndex` of the second factor in the `params` argument.
+ - If there is more than one second factor enrolled, the app should ask the user to select which one to use and specify the index of this as the `selectedIndex`
+ - If there is only one, the `selectedIndex` should be specified as `0`.
+- As with [verifyPhoneNumber](#verifyphonenumber), this may require the user to manually input the verification code received in an SMS message.
+ - In this case, once the user has entered the code, `enrollSecondAuthFactor` will need to be called again with the `credential` option used to specified the `code` and verification `id`.
+- This function involves a similar verification flow to [verifyPhoneNumber](#verifyphonenumber) and therefore has the same pre-requisites and requirements.
+- See the Firebase MFA documentation for [Android](https://cloud.google.com/identity-platform/docs/android/mfa) and [iOS](https://cloud.google.com/identity-platform/docs/ios/mfa) for more information on MFA-specific setup requirements.
+
+**Parameters**:
+
+- {function} success - callback function to invoke either upon:
+ - successful verification : will be passed `true` as an argument
+ - user-entered verification code required: will be passed a `credential` object with a verification `id`.
+- {function} error - callback function which will be passed a {string} error message as an argument
+- {object} params - conditionally required parameters - either:
+ - {integer} selectedIndex - index of selected second factor phone number to use for verification.
+ - {object} credential - if manual entry of the verification code in an SMS is required, the `credential` object will be passed to the `success` function. The user-entered code should be appended to this object as the `code` property then this function
+- {object} opts - (optional Android only) parameters
+ re-invoked with the `credential` specified in the `opts` argument.
+ - {integer} timeOutDuration - time to wait in seconds before timing out. Defaults to 30 seconds if not specified.
+ - {boolean} requireSmsValidation - whether to always require SMS validation on Android even if instant verification is available. Defaults to false if not specified.
+ - {string} fakeVerificationCode - to test instant verification on Android, specify a fake verification code to return for whitelisted phone numbers.
+ - See [Firebase SDK Phone Auth Android Integration Testing](https://firebase.google.com/docs/auth/android/phone-auth#integration-testing) for more info.
+ - {string} phoneNumber - phone number to use for fake instant verification - required if `fakeVerificationCode` is specified
+
+Example usage:
+
+```javascript
+var selectedIndex, credential;
+
+function verifySecondAuthFactor() {
+ FirebasePlugin.verifySecondAuthFactor(
+ function (result) {
+ if (typeof result === "object") {
+ // User must enter SMS verification code manually
+ credential = result;
+ promptUserToInputCode() // you need to implement this
+ .then(function (userEnteredCode) {
+ credential.code = userEnteredCode; // set the user-entered verification code on the credential object
+ verifySecondAuthFactor(); // re-invoke the function with the credential
+ });
+ } else {
+ console.log("Second factor successfully enrolled");
+ }
+ },
+ function (error) {
+ console.error(
+ "Failed to enroll second factor: " + JSON.stringify(error)
+ );
+ },
+ {
+ selectedIndex: selectedIndex,
+ credential: credential,
+ }
+ );
+}
+
+FirebasePlugin.signInWithCredential(
+ credential,
+ function () {
+ console.log("Successfully signed in");
+ },
+ function (error, secondFactors) {
+ if (
+ error === "Second factor required" &&
+ typeof secondFactors !== "undefined"
+ ) {
+ if (secondFactors.length === 1) {
+ // Only 1 enrolled second factor so select and use it
+ selectedIndex = 0;
+ verifySecondAuthFactor();
+ } else {
+ // Multiple second factors enrolled so ask user to choose which to use
+ promptUserToSelectFactor(secondFactors) // you need to implement this
+ .then(function (_selectedIndex) {
+ selectedIndex = _selectedIndex;
+ verifySecondAuthFactor();
+ });
+ }
+ } else {
+ console.error("Failed to sign in", error);
+ }
+ }
+);
+```
+
+### listEnrolledSecondAuthFactors
+
+Lists the second factors the current user has enrolled for multi-factor authentication (MFA).
+
+- Calling when no user is signed in will result in error callback being invoked.
+
+**Parameters**:
+
+- {function} success - callback function to invoke upon successfully retrieving second factors. Will be passed an {array} of second factor {object} with properties:
+
+ - {integer} index - index of the factor in the list
+ - {string} displayName - name of factor specified by the user when this factor was enrolled.
+ - If no name was specified during enrollment, defaults to the masked phone number.
+ - {string} phoneNumber - (Android only) enrolled phone number for this factor.
+ - On iOS, this is not available when listing enrolled factors.
+
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+Example usage:
+
+```javascript
+FirebasePlugin.listEnrolledSecondAuthFactors(
+ function (secondFactors) {
+ if (secondFactors.length > 0) {
+ for (var secondFactor of secondFactors) {
+ console.log(
+ `${secondFactor.index}: ${secondFactor.displayName}${
+ secondFactor.phoneNumber
+ ? " (" + secondFactor.phoneNumber + ")"
+ : ""
+ }`
+ );
+ }
+ } else {
+ console.log("No second factors are enrolled");
+ }
+ },
+ function (error) {
+ console.error(
+ "Failed to list second factors: " + JSON.stringify(error)
+ );
+ }
+);
+```
+
+### unenrollSecondAuthFactor
+
+Unenrolls (removes) an enrolled second factor that the current user has enrolled for multi-factor authentication (MFA).
+
+- Calling when no user is signed in will result in error callback being invoked.
+
+**Parameters**:
+
+- {function} success - callback function to invoke upon success
+- {function} error - callback function which will be passed a {string} error message as an argument
+- {number} selectedIndex - Index of the second factor to unenroll (obtained using [listEnrolledSecondAuthFactors](#listenrolledsecondauthfactors))
+
+Example usage:
+
+```javascript
+function unenrollSecondAuthFactor() {
+ FirebasePlugin.listEnrolledSecondAuthFactors(
+ function (secondFactors) {
+ askUserToSelectSecondFactorToUnenroll(secondFactors) // you implement this
+ .then(function (selectedIndex) {
+ FirebasePlugin.unenrollSecondAuthFactor(
+ function () {
+ console.log(
+ "Successfully unenrolled selected second factor"
+ );
+ },
+ function (error) {
+ console.error(
+ "Failed to unenroll second factor: " +
+ JSON.stringify(error)
+ );
+ },
+ selectedIndex
+ );
+ });
+ },
+ function (error) {
+ console.error(
+ "Failed to list second factors: " + JSON.stringify(error)
+ );
+ }
+ );
+}
+```
+
+### setLanguageCode
+
+Sets the user-facing language code for auth operations that can be internationalized, such as sendEmailVerification() or verifyPhoneNumber(). This language code should follow the conventions defined by the IETF in BCP47.
+
+**Parameters**:
+
+- {string} lang - language to change, ex: 'fr' for french
+
+Example usage:
+
+```javascript
+FirebasePlugin.setLanguageCode("fr"); // will switch to french
+```
+
+### authenticateUserWithEmailAndPassword
+
+Authenticates the user with email/password-based user account to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user.
+
+**Parameters**:
+
+- {string} email - user email address
+- {string} password - user password
+- {function} success - callback function to pass {object} credentials to as an argument. The credential object has the following properties:
+ - {string} id - the identifier of a native credential object which can be used for signing in the user.
+- {function} error - callback function which will be passed a {string} error message as an argument
+ - If the error is due to the user account requiring multi-factor authentication, a second {array} argument will be passed containing a list of enrolled factors.
+ - A factor should be selected and used for second factor verification - see [verifySecondAuthFactor](#verifysecondauthfactor) for more on this.
+
+Example usage:
+
+```javascript
+FirebasePlugin.authenticateUserWithEmailAndPassword(
+ email,
+ password,
+ function (credential) {
+ console.log("Successfully authenticated with email/password");
+ FirebasePlugin.reauthenticateWithCredential(
+ credential,
+ function () {
+ console.log("Successfully re-authenticated");
+ },
+ function (error) {
+ console.error("Failed to re-authenticate", error);
+ }
+ );
+ // User is now signed in
+ },
+ function (error, secondFactors) {
+ if (
+ error === "Second factor required" &&
+ typeof secondFactors !== "undefined"
+ ) {
+ handleSecondFactorAuthentation(secondFactors); // you need to implement this
+ } else {
+ console.error("Failed to authenticate with email/password", error);
+ }
+ }
+);
+```
+
+### authenticateUserWithGoogle
+
+Authenticates the user with a Google account to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user.
+
+**Parameters**:
+
+- {string} clientId - your OAuth 2.0 client ID - [see here](https://developers.google.com/identity/sign-in/android/start-integrating#get_your_backend_servers_oauth_20_client_id) how to obtain it.
+- {function} success - callback function to pass {object} credentials to as an argument. The credential object has the following properties:
+ - {string} id - the identifier of a native credential object which can be used for signing in the user.
+ - {string} idToken - the identiy token from Google account. Could be useful if you want to sign-in with on JS layer.
+- {function} error - callback function which will be passed a {string} error message as an argument
+
+Example usage:
+
+```javascript
+FirebasePlugin.authenticateUserWithGoogle(
+ clientId,
+ function (credential) {
+ FirebasePlugin.signInWithCredential(
+ credential,
+ function () {
+ console.log("Successfully signed in");
+ },
+ function (error) {
+ console.error("Failed to sign in", error);
+ }
+ );
+ },
+ function (error) {
+ console.error("Failed to authenticate with Google: " + error);
+ }
+);
+```
+
+#### Android
+
+To use Google Sign-in in your Android app you need to do the following:
+
+- Add the SHA-1 fingerprint of your app's signing key to your Firebase project
+- Enable Google Sign-in in the Firebase console
+
+For details how to do the above, see the [Google Sign-In on Android page](https://firebase.google.com/docs/auth/android/google-signin) in the Firebase documentation.
+
++ +**Server side verification** + +Once the id token has been obtained from `authenticateUserWithGoogle()` it can be sent to your server to get access to more information about the user's google account. However, it's recommended by Google that the id token be validated on your server before being used. You should generally not trust tokens supplied by clients without performing this validation. While you can write the code to perform this check yourself, it's strongly recommended that you use a library supplied by Google such as [google-auth-library](https://www.npmjs.com/package/google-auth-library) for this purpose. + +The following is sample coded taken from [Google documentation](https://developers.google.com/identity/sign-in/web/backend-auth) for performing a server side verification of an id token: + +```javascript +const { OAuth2Client } = require("google-auth-library"); + +const client = new OAuth2Client(CLIENT_ID); + +async function verify() { + const ticket = await client.verifyIdToken({ + idToken: token, + audience: CLIENT_ID, // Specify the CLIENT_ID of the app that accesses the backend + // Or, if multiple clients access the backend: + //[CLIENT_ID_1, CLIENT_ID_2, CLIENT_ID_3] + }); + const payload = ticket.getPayload(); + const userid = payload["sub"]; + // If request specified a G Suite domain: + // const domain = payload['hd']; +} +verify().catch(console.error); +``` + +
+ +### authenticateUserWithApple + +Authenticates the user with an Apple account using Sign In with Apple to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user. + +To use Sign In with Apple you must ensure your app's provisioning profile has this capability and it is enabled in your Xcode project. +You can enable the capability in Xcode by setting the `IOS_ENABLE_APPLE_SIGNIN` plugin variable at plugin installation time: + + cordova plugin add cordova-plugin-firebasex --variable IOS_ENABLE_APPLE_SIGNIN=true + +**Parameters**: + +- {function} success - callback function to pass {object} credentials to as an argument. The credential object has the following properties: + - {string} id - the identifier of a native credential object which can be used for signing in the user. +- {function} error - callback function which will be passed a {string} error message as an argument +- {string} locale - (Android only) the language to display Apple's Sign-in screen in. + - Defaults to "en" (English) if not specified. + - See [the Apple documentation](https://developer.apple.com/documentation/signinwithapplejs/incorporating_sign_in_with_apple_into_other_platforms###2112) for a list of supported locales. + - The value is ignored on iOS which uses the locale of the device to determine the display language. + +Example usage: + +```javascript +FirebasePlugin.authenticateUserWithApple( + function (credential) { + FirebasePlugin.signInWithCredential( + credential, + function () { + console.log("Successfully signed in"); + }, + function (error) { + console.error("Failed to sign in", error); + } + ); + }, + function (error) { + console.error("Failed to authenticate with Apple: " + error); + }, + "en_GB" +); +``` + +#### iOS + +To use Sign In with Apple in your iOS app you need to do the following: + +- Configure your app for Sign In with Apple as outlined in the [Firebase documentation's "Before you begin" section](https://firebase.google.com/docs/auth/ios/apple#before-you-begin) +- After adding the `cordova-ios` platform, open the project workspace in Xcode (`platforms/ios/YourApp.xcworkspace`) and add the "Sign In with Apple" capability in the "Signing & Capabilities section" + - Note: AFAIK there is currently no way to automate the addition of this capability + +#### Android + +To use Sign In with Apple in your Android app you need to do the following: + +- Configure your app for Sign In with Apple as outlined in the [Firebase documentation's "Before you begin" section](https://firebase.google.com/docs/auth/android/apple#before-you-begin) + +### authenticateUserWithMicrosoft + +Authenticates the user with a Microsoft account using Sign In with Oauth to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user. + +- See [Firebase documentation "Authenticate Using Microsoft" section](https://firebase.google.com/docs/auth/web/microsoft-oauth) + +**Parameters**: + +- {function} success - callback function to pass {object} credentials to as an argument. The credential object has the following properties: + - {string} id - the identifier of a native credential object which can be used for signing in the user. +- {function} error - callback function which will be passed a {string} error message as an argument +- {string} locale - (Android only) the language to display Microsoft's Sign-in screen in. + - Defaults to "en" (English) if not specified. + - See [the Microsoft documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-localization#supported-languages) for a list of supported locales. + - The value is ignored on iOS which uses the locale of the device to determine the display language. + +Example usage: + +```javascript +FirebasePlugin.authenticateUserWithMicrosoft( + function (credential) { + FirebasePlugin.signInWithCredential( + credential, + function () { + console.log("Successfully signed in"); + }, + function (error) { + console.error("Failed to sign in", error); + } + ); + }, + function (error) { + console.error("Failed to authenticate with Microsoft: " + error); + }, + "en_GB" +); +``` + +### authenticateUserWithFacebook + +Authenticates the user with a Facebook account using a Facebook access token to obtain a Firebase credential that can be used to sign the user in/link to an existing user account/reauthenticate the user. + +- Requires a 3rd party plugin such as [cordova-plugin-facebook-connect](https://github.com/cordova-plugin-facebook-connect/cordova-plugin-facebook-connect) to obtain the access token via the Facebook SDK. +- See the "Before you begin" sections for pre-requisites for using Facebook authentication in your app: + - [Android](https://firebase.google.com/docs/auth/android/facebook-login#before_you_begin) + - [iOS](https://firebase.google.com/docs/auth/ios/facebook-login#before_you_begin) + +**Parameters**: + +- {function} success - callback function to pass {object} credentials to as an argument. The credential object has the following properties: + - {string} id - the identifier of a native credential object which can be used for signing in the user. +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript +facebookConnectPlugin.login( + ["public_profile"], + function (userData) { + var accessToken = userData.authResponse.accessToken; + FirebasePlugin.authenticateUserWithFacebook( + accessToken, + function (credential) { + FirebasePlugin.signInWithCredential( + credential, + function () { + console.log("Successfully signed in with Facebook"); + }, + function (error) { + console.error("Failed to sign in with Facebook", error); + } + ); + }, + function (error) { + console.error("Failed to authenticate with Facebook", error); + } + ); + }, + function (error) { + console.error("Failed to login to Facebook", error); + } +); +``` + +### authenticateUserWithOAuth + +Authenticates the user with an OpenID Connect (OIDC) compliant provider to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user. + +- You must configure your OIDC provider in the Firebase console before using this method as outlined in the [Firebase documentation](https://firebase.google.com/docs/auth/web/openid-connect); +- See Firebase documentation "Authenticate Using OpenID Connect" sections for [Android](https://firebase.google.com/docs/auth/android/openid-connect) and [iOS](https://firebase.google.com/docs/auth/ios/openid-connect) for more info. + +**Parameters**: + +- {function} success - callback function to pass {object} credentials to as an argument. The credential object has the following properties: + - {string} id - the identifier of a native credential object which can be used for signing in the user. +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript +var providerId = "oidc.provider"; +var customParameters = { + login_hint: "user@domain.com", +}; +var scopes = ["openid", "profile", "email"]; + +FirebasePlugin.authenticateUserWithOAuth( + function (credential) { + console.log("Successfully authenticated with oAuth provider"); + FirebasePlugin.signInWithCredential( + credential, + function () { + console.log("Successfully signed in"); + }, + function (error) { + console.error("Failed to sign in", error); + } + ); + }, + function (error) { + console.error("Failed to authenticate with oAuth provider: " + error); + }, + providerId, + customParameters, + scopes +); +``` + +### signInWithCredential + +Signs the user into Firebase with credentials obtained via an authentication method such as `verifyPhoneNumber()` or `authenticateUserWithGoogle()`. +See the [Android-](https://firebase.google.com/docs/auth/android/phone-auth#sign-in-the-user) and [iOS](https://firebase.google.com/docs/auth/ios/phone-auth#sign-in-the-user-with-the-verification-code)-specific Firebase documentation for more info. + +**Parameters**: + +- {object} credential - a credential object returned by the success callback of an authentication method; may have the following keys: + - {string} id - the identifier of a native credential object which can be used for signing in the user. + Present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `true`, or if another authentication method was used such as `authenticateUserWithGoogle()`. + - {boolean} instantVerification - true if an Android device and instant verification or auto-retrieval was used to verify the user. + If true, you do not need to provide a user-entered verification. - Only present if the credential was obtained via `verifyPhoneNumber()` + - {string} verificationId - the verification ID to accompany the user-entered verification code from the SMS. + - Only present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`. + - {string} code - if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`, you must set this to the activation code value as entered by the user from the received SMS message. +- {function} success - callback function to call on successful sign-in using credentials +- {function} error - callback function which will be passed a {string} error message as an argument + - If the error is due to the user account requiring multi-factor authentication, a second {array} argument will be passed containing a list of enrolled factors. + - A factor should be selected and used for second factor verification - see [verifySecondAuthFactor](#verifysecondauthfactor) for more on this. + +Example usage: + +```javascript +function signInWithCredential(credential) { + FirebasePlugin.signInWithCredential( + credential, + function () { + console.log("Successfully signed in"); + }, + function (error, secondFactors) { + if ( + error === "Second factor required" && + typeof secondFactors !== "undefined" + ) { + handleSecondFactorAuthentation(secondFactors); // you need to implement this + } else { + console.error("Failed to sign in", error); + } + } + ); +} +``` + +### linkUserWithCredential + +Links an existing Firebase user account with credentials obtained via an authentication method such as `verifyPhoneNumber()` or `authenticateUserWithGoogle()`. +See the [Android-](https://firebase.google.com/docs/auth/android/account-linking) and [iOS](https://firebase.google.com/docs/auth/ios/account-linking)-specific Firebase documentation for more info. + +**Parameters**: + +- {object} credential - a credential object returned by the success callback of an authentication method; may have the following keys: + - {string} id - the identifier of a native credential object which can be used for signing in the user. + Present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `true`, or if another authentication method was used such as `authenticateUserWithGoogle()`. + - {boolean} instantVerification - true if an Android device and instant verification or auto-retrieval was used to verify the user. + If true, you do not need to provide a user-entered verification. - Only present if the credential was obtained via `verifyPhoneNumber()` + - {string} verificationId - the verification ID to accompany the user-entered verification code from the SMS. + - Only present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`. + - {string} code - if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`, you must set this to the activation code value as entered by the user from the received SMS message. +- {function} success - callback function to call on successful linking using credentials +- {function} error - callback function which will be passed a {string} error message as an argument + - If the error is due to the user account requiring multi-factor authentication, a second {array} argument will be passed containing a list of enrolled factors. + - A factor should be selected and used for second factor verification - see [verifySecondAuthFactor](#verifysecondauthfactor) for more on this. + +Example usage: + +```javascript +function linkUserWithCredential(credential) { + FirebasePlugin.linkUserWithCredential( + credential, + function () { + console.log("Successfully linked"); + }, + function (error, secondFactors) { + if ( + error === "Second factor required" && + typeof secondFactors !== "undefined" + ) { + handleSecondFactorAuthentation(secondFactors); // you need to implement this + } else { + console.error("Failed to link", error); + } + } + ); +} +``` + +### reauthenticateWithCredential + +Reauthenticates the currently signed in user with credentials obtained via an authentication method such as `verifyPhoneNumber()` or `authenticateUserWithGoogle()`. + +**Parameters**: + +- {object} credential - a credential object returned by the success callback of an authentication method; may have the following keys: + - {string} id - the identifier of a native credential object which can be used for signing in the user. + Present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `true`, or if another authentication method was used such as `authenticateUserWithGoogle()`. + - {boolean} instantVerification - true if an Android device and instant verification or auto-retrieval was used to verify the user. + If true, you do not need to provide a user-entered verification. - Only present if the credential was obtained via `verifyPhoneNumber()` + - {string} verificationId - the verification ID to accompany the user-entered verification code from the SMS. + - Only present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`. + - {string} code - if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`, you must set this to the activation code value as entered by the user from the received SMS message. +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript +FirebasePlugin.reauthenticateWithCredential( + credential, + function () { + console.log("Successfully reauthenticated"); + }, + function (error, secondFactors) { + if ( + error === "Second factor required" && + typeof secondFactors !== "undefined" + ) { + handleSecondFactorAuthentation(secondFactors); // you need to implement this + } else { + console.error("Failed to reauthenticate", error); + } + } +); +``` + +### unlinkUserWithProvider + +Unlinks an existing Firebase user account with the specified provider ID. +See the [Android-](https://firebase.google.com/docs/auth/android/account-linking#unlink-an-auth-provider-from-a-user-account) and [iOS](https://firebase.google.com/docs/auth/ios/account-linking#unlink-an-auth-provider-from-a-user-account)-specific Firebase documentation for more info. + +**Parameters**: + +- {string} providerId - ID of provider to unlink from user account +- {function} success - callback function to call on successful unlinking of provider +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript +var providerId = "microsoft.com"; +FirebasePlugin.unlinkUserWithProvider( + providerId, + function () { + console.log("Successfully unlinked"); + }, + function (error) { + console.error("Failed to unlink", error); + } +); +``` + +### registerAuthStateChangeListener + +Registers a Javascript function to invoke when Firebase Authentication state changes between user signed in/signed out. + +**Parameters**: + +- {function} fn - callback function to invoke when authentication state changes + - Will be a passed a single boolean argument which is `true` if user just signed in and `false` if user just signed out. + +Example usage: + +```javascript +FirebasePlugin.registerAuthStateChangeListener(function (userSignedIn) { + console.log( + "Auth state changed: User signed " + (userSignedIn ? "in" : "out") + ); +}); +``` + +### registerAuthIdTokenChangeListener + +Registers a Javascript function to invoke when Firebase Authentication ID token changes. + +This can be invoked in the following circumstances: + +- When a user signs in +- When the current user signs out +- When the current user changes +- When there is a change in the current user's token + +**Parameters**: + +- {function} fn - callback function to invoke when ID token changes + - If token is present, will be a passed a single object argument with a `idToken` and `providerId` keys. + - If the token is not present, the function will be invoked with no arguments. + +Example usage: + +```javascript +FirebasePlugin.registerAuthIdTokenChangeListener(function (result) { + if (result) { + console.log( + "Auth ID token changed to: " + + result.idToken + + "; providerId: " + + result.providerId + ); + } else { + console.log("Auth ID token not present"); + } +}); +``` + +### useAuthEmulator + +Instruments your app to talk to the [Firebase Authentication emulator](https://firebase.google.com/docs/emulator-suite/connect_auth). + +**Parameters**: + +- {string} host - hostname or IP address of the Authentication emulator. +- {integer} port - port of the Authentication emulator. +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript +FirebasePlugin.useAuthEmulator( + "localhost", + 9099, + function () { + console.log("Using Firebase Authentication emulator"); + }, + function (error) { + console.error( + "Failed to enable the Firebase Authentication emulator", + error + ); + } +); +``` + +### getClaims + +Returns the entire payload claims of the ID token including the standard reserved claims as well as the custom claims (set by developer via Admin SDK). + +**Parameters**: + +- {function} success - callback function to pass claims {object} to as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript +FirebasePlugin.getClaims( + function (claims) { + // reserved claims + console.log("email", claims.email); + console.log("email_verified", claims.email_verified); + console.log("name", claims.name); + console.log("user_id", claims.user_id); + + //custom claims + console.log("exampleClaimA", claims.exampleClaimA); + console.log("exampleClaimB", claims.exampleClaimB); + }, + function (error) { + console.error("Failed to fetch claims", error); + } +); +``` + +## Remote Config + +### fetch + +Fetch Remote Config parameter values for your app: + +**Parameters**: + +- {integer} cacheExpirationSeconds (optional) - cache expiration in seconds. + According to [the documentation](https://firebase.google.com/docs/remote-config/use-config-web#throttling) the default behavior is to cache for 12 hours, so if you want to quickly detect changes make sure you set this value. +- {function} success - callback function on successfully fetching remote config +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.fetch( + function () { + // success callback + }, + function () { + // error callback + } +); +// or, specify the cacheExpirationSeconds +FirebasePlugin.fetch( + 600, + function () { + // success callback + }, + function () { + // error callback + } +); +``` + +### activateFetched + +Activate the Remote Config fetched config: + +**Parameters**: + +- {function} success - callback function which will be passed a {boolean} argument indicating whether result the current call activated the fetched config. +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.activateFetched( + function (activated) { + // activated will be true if there was a fetched config activated, + // or false if no fetched config was found, or the fetched config was already activated. + console.log(activated); + }, + function (error) { + console.error(error); + } +); +``` + +### fetchAndActivate + +Fetches and activates the Remote Config in a single operation. + +**Parameters**: + +- {function} success - callback function which will be passed a {boolean} argument indicating whether result the current call activated the fetched config. +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.fetchAndActivate( + function (activated) { + // activated will be true if there was a fetched config activated, + // or false if no fetched config was found, or the fetched config was already activated. + console.log(activated); + }, + function (error) { + console.error(error); + } +); +``` + +### resetRemoteConfig + +Deletes all activated, fetched and defaults configs and resets all Firebase Remote Config settings. + +Android only. + +**Parameters**: + +- {function} success - callback function to call on successful reset. +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.resetRemoteConfig( + function () { + console.log("Successfully reset remote config"); + }, + function (error) { + console.error("Error resetting remote config: " + error); + } +); +``` + +### getValue + +Retrieve a Remote Config value: + +**Parameters**: + +- {string} key - key for which to fetch associated value +- {function} success - callback function which will be passed a {string} argument containing the value stored against the specified key. + If the expected value is of a different primitive type (e.g. `boolean`, `integer`) you should cast the value to the appropriate type. +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.getValue( + "key", + function (value) { + console.log(value); + }, + function (error) { + console.error(error); + } +); +``` + +### getInfo + +Get the current state of the FirebaseRemoteConfig singleton object: + +**Parameters**: + +- {function} success - callback function which will be passed an {object} argument containing the state info +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.getInfo( + function (info) { + // how many (secs) fetch cache is valid and data will not be refetched + console.log(info.configSettings.minimumFetchInterval); + // value in seconds to abandon a pending fetch request made to the backend + console.log(info.configSettings.fetchTimeout); + // the timestamp (milliseconds since epoch) of the last successful fetch + console.log(info.fetchTimeMillis); + // the status of the most recent fetch attempt (int) + // 0 = Config has never been fetched. + // 1 = Config fetch succeeded. + // 2 = Config fetch failed. + // 3 = Config fetch was throttled. + console.log(info.lastFetchStatus); + }, + function (error) { + console.error(error); + } +); +``` + +### getAll + +Returns all Remote Config as key/value pairs + +**Parameters**: + +- {function} success - callback function which will be passed an {object} argument where key is the remote config key and value is the value as a string. If the expected key value is a different primitive type then cast it to the appropriate type. +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.getAll( + function (values) { + for (var key in values) { + console.log(key + "=" + values[key]); + } + }, + function (error) { + console.error(error); + } +); +``` + +### setConfigSettings + +Changes the default Remote Config settings: + +- Fetch timeout sets how long your app should wait for new Remote Config values before timing out. + - Useful when you don’t want your application to wait longer than X seconds to fetch new Remote Config values +- Minimum fetch interval sets the minimum interval for which you want to check for any new Remote Config parameter values. + - Keep in mind that setting too short an interval in production might cause your app to run into rate limits. + +**Parameters**: + +- {integer} fetchTimeout - fetch timeout in seconds. + - Default is 60 seconds. + - Specify as `null` value to omit setting this value. +- {integer} minimumFetchInterval - minimum fetch inteval in seconds. + - Default is 12 hours. + - Specify as `null` value to omit setting this value. + - Set to `0` to disable minimum interval entirely (**DO NOT** do this in production) +- {function} success - callback function to be call on successfully setting the remote config settings +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +var fetchTimeout = 60; +var minimumFetchInterval = 3600; +FirebasePlugin.setConfigSettings( + fetchTimeout, + minimumFetchInterval, + function () { + console.log("Successfully set Remote Config settings"); + }, + function (error) { + console.error("Error setting Remote Config settings: " + error); + } +); +``` + +### setDefaults + +Sets in-app default values for your Remote Config parameters until such time as values are populated from the remote service via a fetch/activate operation. + +**Parameters**: + +- {object} defaults - object specifying the default remote config settings + - key is the name of your Remote Config parameter + - value is the default value +- {function} success - callback function to be call on successfully setting the remote config parameter defaults +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +// define defaults +var defaults = { + my_int: 1, + my_double: 3.14, + my_boolean: true, + my_string: "hello world", + my_json: { foo: "bar" }, +}; +// set defaults +FirebasePlugin.setDefaults(defaults); +``` + +## Performance + +### setPerformanceCollectionEnabled + +Manually enable/disable performance data collection, e.g. if [disabled on app startup](#disable-data-collection-on-startup). + +**Parameters**: + +- {boolean} setEnabled - whether to enable or disable performance data collection + +```javascript +FirebasePlugin.setPerformanceCollectionEnabled(true); // Enables performance data collection + +FirebasePlugin.setPerformanceCollectionEnabled(false); // Disables performance data collection +``` + +### isPerformanceCollectionEnabled + +Indicates whether performance data collection is enabled. + +Notes: + +- This value applies both to the current app session and subsequent app sessions until such time as it is changed. +- It returns the value set by [setPerformanceCollectionEnabled()](#setperformancecollectionenabled). +- If automatic data collection was not [disabled on app startup](#disable-data-collection-on-startup), this will always return `true`. + +**Parameters**: + +- {function} success - callback function which will be invoked on success. + Will be passed a {boolean} indicating if the setting is enabled. +- {function} error - (optional) callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.isPerformanceCollectionEnabled( + function (enabled) { + console.log( + "Performance data collection is " + + (enabled ? "enabled" : "disabled") + ); + }, + function (error) { + console.error( + "Error getting Performance data collection setting: " + error + ); + } +); +``` + +### startTrace + +Start a trace. + +**Parameters**: + +- {string} name - name of trace to start +- {function} success - callback function to call on successfully starting trace +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.startTrace("test trace", success, error); +``` + +### incrementCounter + +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: + +**Parameters**: + +- {string} name - name of trace +- {string} counterName - name of counter to increment +- {function} success - callback function to call on successfully incrementing counter +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.incrementCounter("test trace", "retry", success, error); +``` + +### stopTrace + +Stop the trace + +**Parameters**: + +- {string} name - name of trace to stop +- {function} success - callback function to call on successfully stopping trace +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.stopTrace("test trace"); +``` + +## Firestore + +These plugin API functions provide CRUD operations for working with documents in Firestore collections. + +Notes: + +- Only top-level Firestore collections are currently supported - [subcollections](https://firebase.google.com/docs/firestore/manage-data/structure-data#subcollections) (nested collections within documents) are currently not supported due to the complexity of mapping the native objects into the plugin's JS API layer. +- A document object may contain values of primitive Javascript types `string`, `number`, `boolean`, `array` or `object`. + Arrays and objects may contain nested structures of these types. +- If a collection name referenced in a document write operation does not already exist, it will be created by the first write operation referencing it. + +### addDocumentToFirestoreCollection + +Adds a new document to a Firestore collection, which will be allocated an auto-generated document ID. + +**Parameters**: + +- {object} document - document object to add to collection +- {string} collection - name of top-level collection to add document to. +- {boolean} timestamp (optional) - Add 'created' and 'lastUpdate' variables in the document. Default `false`. +- {function} success (optional) - callback function to call on successfully adding the document. + Will be passed a {string} argument containing the auto-generated document ID that the document was stored against. +- {function} error (optional) - callback function which will be passed a {string} error message as an argument. + +```javascript +var document = { + a_string: "foo", + a_list: [1, 2, 3], + an_object: { + an_integer: 1, + }, +}; +var collection = "my_collection"; + +// with timestamp +FirebasePlugin.addDocumentToFirestoreCollection( + document, + collection, + true, + function (documentId) { + console.log("Successfully added document with id=" + documentId); + }, + function (error) { + console.error("Error adding document: " + error); + } +); + +// without timestamp +FirebasePlugin.addDocumentToFirestoreCollection( + document, + collection, + function (documentId) { + console.log("Successfully added document with id=" + documentId); + }, + function (error) { + console.error("Error adding document: " + error); + } +); +``` + +### setDocumentInFirestoreCollection + +Sets (adds/replaces) a document with the given ID in a Firestore collection. + +**Parameters**: + +- {string} documentId - document ID to use when setting document in the collection. +- {object} document - document object to set in collection. +- {string} collection - name of top-level collection to set document in. +- {boolean} timestamp (optional) - Add 'lastUpdate' variable in the document. Default `false`. +- {function} success (optional) - callback function to call on successfully setting the document. +- {function} error (optional) - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var document = { + a_string: "foo", + a_list: [1, 2, 3], + an_object: { + an_integer: 1, + }, +}; +var collection = "my_collection"; + +// with timestamp +FirebasePlugin.setDocumentInFirestoreCollection( + documentId, + document, + collection, + true, + function () { + console.log("Successfully set document with id=" + documentId); + }, + function (error) { + console.error("Error setting document: " + error); + } +); + +// without timestamp +FirebasePlugin.setDocumentInFirestoreCollection( + documentId, + document, + collection, + function () { + console.log("Successfully set document with id=" + documentId); + }, + function (error) { + console.error("Error setting document: " + error); + } +); +``` + +### updateDocumentInFirestoreCollection + +Updates an existing document with the given ID in a Firestore collection. +This is a non-destructive update that will only overwrite existing keys in the existing document or add new ones if they don't already exist. +If the no document with the specified ID exists in the collection, an error will be raised. + +**Parameters**: + +- {string} documentId - document ID of the document to update. +- {object} document - entire document or document fragment to update existing document with. +- {string} collection - name of top-level collection to update document in. +- {boolean} timestamp (optional) - Add 'lastUpdate' variable in the document. Default `false`. +- {function} success (optional) - callback function to call on successfully updating the document. +- {function} error (optional) - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var documentFragment = { + a_string: "new value", + a_new_string: "bar", +}; +var collection = "my_collection"; + +// with timestamp +FirebasePlugin.updateDocumentInFirestoreCollection( + documentId, + documentFragment, + collection, + true, + function () { + console.log("Successfully updated document with id=" + documentId); + }, + function (error) { + console.error("Error updating document: " + error); + } +); + +// without timestamp +FirebasePlugin.updateDocumentInFirestoreCollection( + documentId, + documentFragment, + collection, + function () { + console.log("Successfully updated document with id=" + documentId); + }, + function (error) { + console.error("Error updating document: " + error); + } +); +``` + +### deleteDocumentFromFirestoreCollection + +Deletes an existing document with the given ID in a Firestore collection. + +Note: If the no document with the specified ID exists in the collection, the Firebase SDK will still return a successful outcome. + +**Parameters**: + +- {string} documentId - document ID of the document to delete. +- {string} collection - name of top-level collection to delete document in. +- {function} success - callback function to call on successfully deleting the document. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var collection = "my_collection"; +FirebasePlugin.deleteDocumentFromFirestoreCollection( + documentId, + collection, + function () { + console.log("Successfully deleted document with id=" + documentId); + }, + function (error) { + console.error("Error deleting document: " + error); + } +); +``` + +### documentExistsInFirestoreCollection + +Indicates if a document with the given ID exists in a Firestore collection. + +**Parameters**: + +- {string} documentId - document ID of the document. +- {string} collection - name of top-level collection to check for document. +- {function} success - callback function to call pass result. + Will be passed an {boolean} which is `true` if a document exists. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var collection = "my_collection"; +FirebasePlugin.documentExistsInFirestoreCollection( + documentId, + collection, + function (exists) { + console.log("Document " + (exists ? "exists" : "doesn't exist")); + }, + function (error) { + console.error("Error fetching document: " + error); + } +); +``` + +### fetchDocumentInFirestoreCollection + +Fetches an existing document with the given ID from a Firestore collection. + +Notes: + +- If no document with the specified ID exists in the collection, the error callback will be invoked. +- If the document contains references to another document, they will be converted to the document path string to avoid circular reference issues. + +**Parameters**: + +- {string} documentId - document ID of the document to fetch. +- {string} collection - name of top-level collection to fetch document from. +- {function} success - callback function to call on successfully fetching the document. + Will be passed an {object} contain the document contents. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var collection = "my_collection"; +FirebasePlugin.fetchDocumentInFirestoreCollection( + documentId, + collection, + function (document) { + console.log( + "Successfully fetched document: " + JSON.stringify(document) + ); + }, + function (error) { + console.error("Error fetching document: " + error); + } +); +``` + +### fetchFirestoreCollection + +Fetches all the documents in the specific collection. + +Notes: + +- If no collection with the specified name exists, the error callback will be invoked. +- If the documents in the collection contain references to another document, they will be converted to the document path string to avoid circular reference issues. + +**Parameters**: + +- {string} collection - name of top-level collection to fetch. +- {array} filters (optional) - a list of filters to sort/filter the documents returned from your collection. + + - Supports `where`, `orderBy`, `startAt`, `endAt` and `limit` filters. + - See the [Firestore documentation](https://firebase.google.com/docs/firestore/query-data/queries) for more details. + - Each filter is defined as an array of filter components: + - `where`: [`where`, `fieldName`, `operator`, `value`, `valueType`] + - `fieldName` - name of field to match + - `operator` - operator to apply to match + - supported operators: `==`, `<`, `>`, `<=`, `>=`, `array-contains` + - `value` - field value to match + - `valueType` (optional) - type of variable to fetch value as + - supported types: `string`, `boolean`, `integer`, `double`, `long` + - if not specified, defaults to `string` + - `startAt`: [`startAt`, `value`, `valueType`] + - `value` - field value to start at + - `valueType` (optional) - type of variable to fetch value as (as above) + - `endAt`: [`endAt`, `value`, `valueType`] + - `value` - field value to end at + - `valueType` (optional) - type of variable to fetch value as (as above) + - `orderBy`: [`orderBy`, `fieldName`, `sortDirection`] + - `fieldName` - name of field to order by + - `sortDirection` - direction to order in: `asc` or `desc` + - `limit`: [`limit`, `value`] + - `value` - `integer` defining maximum number of results to return. + +- {function} success - callback function to call on successfully deleting the document. + Will be passed an {object} containing all the documents in the collection, indexed by document ID. + If a Firebase collection with that name does not exist or it contains no documents, the object will be empty. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var collection = "my_collection"; +var filters = [ + ["where", "my_string", "==", "foo"], + ["where", "my_integer", ">=", 0, "integer"], + ["where", "my_boolean", "==", true, "boolean"], + ["orderBy", "an_integer", "desc"], + ["startAt", "an_integer", 10, "integer"], + ["endAt", "an_integer", 100, "integer"], + ["limit", 100000], +]; + +FirebasePlugin.fetchFirestoreCollection( + collection, + filters, + function (documents) { + console.log( + "Successfully fetched collection: " + JSON.stringify(documents) + ); + }, + function (error) { + console.error("Error fetching collection: " + error); + } +); +``` + +### listenToDocumentInFirestoreCollection + +Adds a listener to detect real-time changes to the specified document. + +Note: If the document contains references to another document, they will be converted to the document path string to avoid circular reference issues. + +Upon adding a listener using this function, the success callback function will be invoked with an `id` event which specifies the native ID of the added listener. +This can be used to subsequently remove the listener using [`removeFirestoreListener()`](#removefirestorelistener). +For example: + +```json +{ + "eventType": "id", + "id": 12345 +} +``` + +The callback will also be immediately invoked again with a `change` event which contains a snapshot of the document at the time of adding the listener. +Then each time the document is changed, either locally or remotely, the callback will be invoked with another `change` event detailing the change. + +Event fields: + +- `source` - specifies if the change was `local` (made locally on the app) or `remote` (made via the server). +- `fromCache` - specifies whether the snapshot was read from local cache +- `snapshot` - a snapshot of document at the time of the change. + - May not be present if change event is due to a metadata change. + +For example: + +```json +{ + "eventType": "change", + "source": "remote", + "fromCache": true, + "snapshot": { + "a_field": "a_value" + } +} +``` + +See the [Firestore documentation](https://firebase.google.com/docs/firestore/query-data/listen) for more info on real-time listeners. + +**Parameters**: + +- {function} success - callback function to call on successfully adding the listener AND on subsequently detecting changes to that document. + Will be passed an {object} representing the `id` or `change` event. +- {function} error - callback function which will be passed a {string} error message as an argument. +- {string} documentId - document ID of the document to listen to. +- {string} collection - name of top-level collection to listen to the document in. +- {boolean} includeMetadata - whether to listen for changes to document metadata. + - Defaults to `false`. + - See [Events for metadata changes](https://firebase.google.com/docs/firestore/query-data/listen#events-metadata-changes) for more info. + +```javascript +var documentId = "my_doc"; +var collection = "my_collection"; +var includeMetadata = true; +var listenerId; + +FirebasePlugin.listenToDocumentInFirestoreCollection( + function (event) { + switch (event.eventType) { + case "id": + listenerId = event.id; + console.log( + "Successfully added document listener with id=" + listenerId + ); + break; + case "change": + console.log("Detected document change"); + console.log("Source of change: " + event.source); + console.log("Read from local cache: " + event.fromCache); + if (event.snapshot) { + console.log( + "Document snapshot: " + JSON.stringify(event.snapshot) + ); + } + break; + } + }, + function (error) { + console.error("Error adding listener: " + error); + }, + documentId, + collection, + includeMetadata +); +``` + +### listenToFirestoreCollection + +Adds a listener to detect real-time changes to documents in a Firestore collection. + +Note: If the documents in the collection contain references to another document, they will be converted to the document path string to avoid circular reference issues. + +Upon adding a listener using this function, the success callback function will be invoked with an `id` event which specifies the native ID of the added listener. +This can be used to subsequently remove the listener using [`removeFirestoreListener()`](#removefirestorelistener). +For example: + +```json +{ + "eventType": "id", + "id": 12345 +} +``` + +The callback will also be immediately invoked again with a `change` event which contains a snapshot of all documents in the collection at the time of adding the listener. +Then each time document(s) in the collection change, either locally or remotely, the callback will be invoked with another `change` event detailing the change. + +Event fields: + +- `documents` - key/value list of document changes indexed by document ID. For each document change: + - `source` - specifies if the change was `local` (made locally on the app) or `remote` (made via the server). + - `fromCache` - specifies whether the snapshot was read from local cache + - `type` - specifies the change type: + - `added` - document was added to collection + - `modified` - document was modified in collection + - `removed` - document was removed from collection + - `metadata` - document metadata changed + - `snapshot` - a snapshot of document at the time of the change. + - May not be present if change event is due to a metadata change. + +For example: + +```json +{ + "eventType": "change", + "documents": { + "a_doc": { + "source": "remote", + "fromCache": false, + "type": "added", + "snapshot": { + "a_field": "a_value" + } + }, + "another_doc": { + "source": "remote", + "fromCache": false, + "type": "removed", + "snapshot": { + "foo": "bar" + } + } + } +} +``` + +See the [Firestore documentation](https://firebase.google.com/docs/firestore/query-data/listen) for more info on real-time listeners. + +**Parameters**: + +- {function} success - callback function to call on successfully adding the listener AND on subsequently detecting changes to that collection. + Will be passed an {object} representing the `id` or `change` event. +- {function} error - callback function which will be passed a {string} error message as an argument. +- {string} collection - name of top-level collection to listen to the document in. +- {array} filters (optional) - a list of filters to sort/filter the documents returned from your collection. + - See [fetchFirestoreCollection](#fetchfirestorecollection) +- {boolean} includeMetadata (optional) - whether to listen for changes to document metadata. + - Defaults to `false`. + - See [Events for metadata changes](https://firebase.google.com/docs/firestore/query-data/listen#events-metadata-changes) for more info. + +```javascript +var collection = "my_collection"; +var filters = [ + ["where", "field", "==", "value"], + ["orderBy", "field", "desc"], +]; +var includeMetadata = true; +var listenerId; + +FirebasePlugin.listenToFirestoreCollection( + function (event) { + switch (event.eventType) { + case "id": + listenerId = event.id; + console.log( + "Successfully added collection listener with id=" + + listenerId + ); + break; + case "change": + console.log("Detected collection change"); + if (event.documents) { + for (var documentId in event.documents) { + console.log("Document ID: " + documentId); + + var docChange = event.documents[documentId]; + console.log("Source of change: " + docChange.source); + console.log("Change type: " + docChange.type); + console.log( + "Read from local cache: " + docChange.fromCache + ); + if (docChange.snapshot) { + console.log( + "Document snapshot: " + + JSON.stringify(docChange.snapshot) + ); + } + } + } + break; + } + }, + function (error) { + console.error("Error adding listener: " + error); + }, + collection, + filters, + includeMetadata +); +``` + +### removeFirestoreListener + +Removes an existing native Firestore listener (see [detaching listeners](https://firebase.google.com/docs/firestore/query-data/listen#detach_a_listener)) added with [`listenToDocumentInFirestoreCollection()`](#listentodocumentinfirestorecollection) or [`listenToFirestoreCollection()`](#listentofirestorecollection). + +Upon adding a listener using either of the above functions, the success callback function will be invoked with an `id` event which specifies the native ID of the added listener. +For example: + +```json +{ + "eventType": "id", + "id": 12345 +} +``` + +This can be used to subsequently remove the listener using this function. +You should remove listeners when you're not using them as while active they maintain a continual HTTP connection to the Firebase servers costing memory, bandwith and money: see [best practices for realtime updates](https://firebase.google.com/docs/firestore/best-practices#realtime_updates) and [billing for realtime updates](https://firebase.google.com/docs/firestore/pricing#listens). + +**Parameters**: + +- {function} success - callback function to call on successfully removing the listener. +- {function} error - callback function which will be passed a {string} error message as an argument. +- {string|number} listenerId - ID of the listener to remove + +```javascript +FirebasePlugin.removeFirestoreListener( + function () { + console.log("Successfully removed listener"); + }, + function (error) { + console.error("Error removing listener: " + error); + }, + listenerId +); +``` + +## Functions + +Exposes API methods of the [Firebase Functions SDK](https://firebase.google.com/docs/functions/callable). + +### functionsHttpsCallable + +Call a firebase [Https Callable function](https://firebase.google.com/docs/functions/callable) + +**Parameters**: + +- {string} name - the name of the function +- {object} args - arguments to send to the function +- {function} success - callback function to call on successfully completed the function call. + Will be passed an {object/array/string} containing the data returned by the function +- {function} error - callback function which will be passed a {string/object} error message as an argument. + +```javascript +var functionName = "myBackendFunction"; +var args = { + arg1: "First argument", + arg2: "second argument", +}; +FirebasePlugin.functionsHttpsCallable( + functionName, + args, + function (result) { + console.log("Successfully called function: " + JSON.stringify(result)); + }, + function (error) { + console.error("Error calling function: " + JSON.stringify(error)); + } +); +``` + +## Installations + +Exposes API methods of the [Firebase Installations SDK](https://firebase.google.com/docs/projects/manage-installations). + +### getInstallationId + +[Returns the current Firebase installation ID (FID)](https://firebase.google.com/docs/projects/manage-installations#retrieve_client_identifers). + +**Parameters**: + +- {function} success - callback function to call on successfully completed the function call. + Will be passed the {string} Firebase installation ID. +- {function} error - callback function which will be passed a {string/object} error message as an argument. + +```javascript +FirebasePlugin.getInstallationId( + function (id) { + console.log("Got installation ID: " + id); + }, + function (error) { + console.error("Failed to get installation ID", error); + } +); +``` + +### getInstallationToken + +[Returns the JWT auth token](https://firebase.google.com/docs/projects/manage-installations#retrieve-fis-token) for the current Firebase installation ID (FID). + +**Parameters**: + +- {function} success - callback function to call on successfully completed the function call. + Will be passed the {string} Firebase installation token. +- {function} error - callback function which will be passed a {string/object} error message as an argument. + +```javascript +FirebasePlugin.getInstallationToken( + function (token) { + console.log("Got installation token: " + token); + }, + function (error) { + console.error("Failed to get installation token", error); + } +); +``` + +### getInstallationId + +[Deletes the current Firebase installation ID (FID)](https://firebase.google.com/docs/projects/manage-installations#delete-fid). + +**Parameters**: + +- {function} success - callback function to call on successfully completed the function call. +- {function} error - callback function which will be passed a {string/object} error message as an argument. + +```javascript +FirebasePlugin.deleteInstallationId( + function () { + console.log("Deleted installation ID"); + }, + function (error) { + console.error("Failed to delete installation ID", error); + } +); +``` + +### registerInstallationIdChangeListener + +Registers a Javascript function to invoke when [Firebase Installation ID changes](https://firebase.google.com/docs/projects/manage-installations#monitor-id-lifecycle). + +iOS only. + +**Parameters**: + +- {function} fn - callback function to invoke when installation ID changes. + - Will be a passed a single {string} argument which is the new installation ID. + +Example usage: + +```javascript +FirebasePlugin.registerInstallationIdChangeListener(function (installationId) { + console.log("New installation ID: " + installationId); +}); +``` + +## Miscellaneous + +Functions unrelated to any specific Firebase SDK component. + +### registerApplicationDidBecomeActiveListener + +Registers a Javascript function to invoke when the iOS application becomes active after being in the background. + +- iOS only. + +**Parameters**: + +- {function} fn - callback function to invoke when application becomes active + +Example usage: + +```javascript +FirebasePlugin.registerApplicationDidBecomeActiveListener(function () { + console.log("Application became active"); +}); +``` + +### registerApplicationDidEnterBackgroundListener + +Registers a Javascript function to invoke when the iOS application is sent to the background. + +- iOS only. + +**Parameters**: + +- {function} fn - callback function to invoke when application is sent to the background + +Example usage: + +```javascript +FirebasePlugin.registerApplicationDidEnterBackgroundListener(function () { + console.log("Application send to background"); +}); +``` -## Google Tag Manager +### Debug mode +Enable debug mode to use DebugView. +You can find detailed information [here](https://firebase.google.com/docs/analytics/debugview?hl=es-419#android) +#### Android +1) Connect your developer Android device via USB. +2) Allow the connection on the device. +3) Open your terminal and run + `adb devices -l` +4) If your device appears run + `adb shell setprop debug.firebase.analytics.app PACKAGE.NAME` -Checkout our [guide](docs/GOOGLE_TAG_MANAGER.md) for info on setting up Google Tag Manager. +Now your device is in debug Mode. -## Configuring Notifications +Disable it using +`adb shell setprop debug.firebase.analytics.app .none.` -Checkout our [guide](docs/NOTIFICATIONS.md) for info on configuring notification icons and colors. +#### IOS +Find information [here](https://firebase.google.com/docs/analytics/debugview?hl=es-419#android) -## API +# Credits -See the full [API](docs/API.md) available for this plugin. +- [@robertarnesson](https://github.com/robertarnesson) for the original [cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) from which this plugin is forked. +- [@sagrawal31](https://github.com/sagrawal31) and [Wiz Panda](https://github.com/wizpanda) for contributions via [cordova-plugin-firebase-lib](https://github.com/wizpanda/cordova-plugin-firebase-lib). +- [Full list of contributors](https://github.com/dpa99c/cordova-plugin-firebasex/graphs/contributors) diff --git a/docs/API.md b/docs/API.md deleted file mode 100644 index efa484945..000000000 --- a/docs/API.md +++ /dev/null @@ -1,371 +0,0 @@ -# API - -The list of available methods for this plugin is described below. - -## getToken - -Get the device token (id): -``` -window.FirebasePlugin.getToken(function(token) { - // save this server-side and use it to push notifications to this device - console.log(token); -}, function(error) { - console.error(error); -}); -``` -Note that token will be null if it has not been established yet - -## onTokenRefresh - -Register for token changes: -``` -window.FirebasePlugin.onTokenRefresh(function(token) { - // save this server-side and use it to push notifications to this device - console.log(token); -}, function(error) { - console.error(error); -}); -``` -This is the best way to get a valid token for the device as soon as the token is established - -## onNotificationOpen - -Register notification callback: -``` -window.FirebasePlugin.onNotificationOpen(function(notification) { - console.log(notification); -}, function(error) { - console.error(error); -}); -``` -Notification flow: - -1. App is in foreground: - 1. User receives the notification data in the JavaScript callback without any notification on the device itself (this is the normal behaviour of push notifications, it is up to you, the developer, to notify the user) -2. App is in background: - 1. User receives the notification message in its device notification bar - 2. User taps the notification and the app opens - 3. User receives the notification data in the JavaScript callback - -Notification icon on Android: - -[Changing notification icon](NOTIFICATIONS.md#changing-notification-icon) - -## grantPermission (iOS only) - -Grant permission to receive push notifications (will trigger prompt): -``` -window.FirebasePlugin.grantPermission(); -``` -## hasPermission - -Check permission to receive push notifications: -``` -window.FirebasePlugin.hasPermission(function(data){ - console.log(data.isEnabled); -}); -``` - -## setBadgeNumber - -Set a number on the icon badge: -``` -window.FirebasePlugin.setBadgeNumber(3); -``` - -Set 0 to clear the badge -``` -window.FirebasePlugin.setBadgeNumber(0); -``` - -## getBadgeNumber - -Get icon badge number: -``` -window.FirebasePlugin.getBadgeNumber(function(n) { - console.log(n); -}); -``` - -## clearAllNotifications - -Clear all pending notifications from the drawer: -``` -window.FirebasePlugin.clearAllNotifications(); -``` - -## subscribe - -Subscribe to a topic: -``` -window.FirebasePlugin.subscribe("example"); -``` - -## unsubscribe - -Unsubscribe from a topic: -``` -window.FirebasePlugin.unsubscribe("example"); -``` - -## unregister - -Unregister from firebase, used to stop receiving push notifications. Call this when you logout user from your app. : -``` -window.FirebasePlugin.unregister(); -``` - -## logEvent - -Log an event using Analytics: -``` -window.FirebasePlugin.logEvent("select_content", {content_type: "page_view", item_id: "home"}); -``` - -## setCrashlyticsUserId - -Set Crashlytics user identifier. -- https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#set_user_ids - -## setScreenName - -Set the name of the current screen in Analytics: -``` -window.FirebasePlugin.setScreenName("Home"); -``` - -## setUserId - -Set a user id for use in Analytics: -``` -window.FirebasePlugin.setUserId("user_id"); -``` - -## setUserProperty - -Set a user property for use in Analytics: -``` -window.FirebasePlugin.setUserProperty("name", "value"); -``` - -## verifyPhoneNumber - -Request a verification ID and send a SMS with a verification code. Use them to construct a credential to sign in the user (in your app). -- https://firebase.google.com/docs/auth/android/phone-auth -- https://firebase.google.com/docs/reference/js/firebase.auth.Auth#signInWithCredential -- https://firebase.google.com/docs/reference/js/firebase.User#linkWithCredential - -**NOTE: This will only work on physical devices.** - -iOS will return: credential (string) -Android will return: -credential.verificationId (object and with key verificationId) -credential.instantVerification (boolean) -credential.code (string) (note that this key only exists if instantVerification is true) - -You need to use device plugin in order to access the right key. - -IMPORTANT NOTE: Android supports auto-verify and instant device verification. Therefore in that case it doesn't make sense to ask for an sms code as you won't receive one. In this case you'll get a credential.verificationId and a credential.code where code is the auto received verification code that would normally be sent via sms. To log in using this procedure you must pass this code to PhoneAuthProvider.credential(verificationId, code). You'll find an implementation example further below. - -When using node.js Firebase Admin-SDK, follow this tutorial: -- https://firebase.google.com/docs/auth/admin/create-custom-tokens - -Pass back your custom generated token and call -```js -firebase.auth().signInWithCustomToken(customTokenFromYourServer); -``` -instead of -``` -firebase.auth().signInWithCredential(credential) -``` -**YOU HAVE TO COVER THIS PROCESS, OR YOU WILL HAVE ABOUT 5% OF USERS STICKING ON YOUR SCREEN, NOT RECEIVING ANYTHING** -If this process is too complex for you, use this awesome plugin -- https://github.com/chemerisuk/cordova-plugin-firebase-authentication - -It's not perfect but it fits for the most use cases and doesn't require calling your endpoint, as it has native phone auth support. - -``` -window.FirebasePlugin.verifyPhoneNumber(number, timeOutDuration, function(credential) { - console.log(credential); - - // if instant verification is true use the code that we received from the firebase endpoint, otherwise ask user to input verificationCode: - var code = credential.instantVerification ? credential.code : inputField.value.toString(); - - var verificationId = credential.verificationId; - - var credential = firebase.auth.PhoneAuthProvider.credential(verificationId, code); - - // sign in with the credential - firebase.auth().signInWithCredential(credential); - - // OR link to an account - firebase.auth().currentUser.linkWithCredential(credential) -}, function(error) { - console.error(error); -}); -``` - - -### Android -To use this auth you need to configure your app SHA hash in the android app configuration in the firebase console. -See https://developers.google.com/android/guides/client-auth to know how to get SHA app hash. - -### iOS -Setup your push notifications first, and verify that they are arriving on your physical device before you test this method. Use the APNs auth key to generate the .p8 file and upload it to firebase. When you call this method, FCM sends a silent push to the device to verify it. - -## fetch - -Fetch Remote Config parameter values for your app: -``` -window.FirebasePlugin.fetch(function () { - // success callback -}, function () { - // error callback -}); -// or, specify the cacheExpirationSeconds -window.FirebasePlugin.fetch(600, function () { - // success callback -}, function () { - // error callback -}); -``` - -## activateFetched - -Activate the Remote Config fetched config: -``` -window.FirebasePlugin.activateFetched(function(activated) { - // activated will be true if there was a fetched config activated, - // or false if no fetched config was found, or the fetched config was already activated. - console.log(activated); -}, function(error) { - console.error(error); -}); -``` - -## getValue - -Retrieve a Remote Config value: -``` -window.FirebasePlugin.getValue("key", function(value) { - console.log(value); -}, function(error) { - console.error(error); -}); -// or, specify a namespace for the config value -window.FirebasePlugin.getValue("key", "namespace", function(value) { - console.log(value); -}, function(error) { - console.error(error); -}); -``` - -## getByteArray (Android only) -**NOTE: byte array is only available for SDK 19+** -Retrieve a Remote Config byte array: -``` -window.FirebasePlugin.getByteArray("key", function(bytes) { - // a Base64 encoded string that represents the value for "key" - console.log(bytes.base64); - // a numeric array containing the values of the byte array (i.e. [0xFF, 0x00]) - console.log(bytes.array); -}, function(error) { - console.error(error); -}); -// or, specify a namespace for the byte array -window.FirebasePlugin.getByteArray("key", "namespace", function(bytes) { - // a Base64 encoded string that represents the value for "key" - console.log(bytes.base64); - // a numeric array containing the values of the byte array (i.e. [0xFF, 0x00]) - console.log(bytes.array); -}, function(error) { - console.error(error); -}); -``` - -## getInfo (Android only) - -Get the current state of the FirebaseRemoteConfig singleton object: -``` -window.FirebasePlugin.getInfo(function(info) { - // the status of the developer mode setting (true/false) - console.log(info.configSettings.developerModeEnabled); - // the timestamp (milliseconds since epoch) of the last successful fetch - console.log(info.fetchTimeMillis); - // the status of the most recent fetch attempt (int) - // 0 = Config has never been fetched. - // 1 = Config fetch succeeded. - // 2 = Config fetch failed. - // 3 = Config fetch was throttled. - console.log(info.lastFetchStatus); -}, function(error) { - console.error(error); -}); -``` - -## setConfigSettings (Android only) - -Change the settings for the FirebaseRemoteConfig object's operations: -``` -var settings = { - developerModeEnabled: true -} -window.FirebasePlugin.setConfigSettings(settings); -``` - -## setDefaults (Android only) - -Set defaults in the Remote Config: -``` -// define defaults -var defaults = { - // map property name to value in Remote Config defaults - mLong: 1000, - mString: 'hello world', - mDouble: 3.14, - mBoolean: true, - // map "mBase64" to a Remote Config byte array represented by a Base64 string - // Note: the Base64 string is in an array in order to differentiate from a string config value - mBase64: ["SGVsbG8gV29ybGQ="], - // map "mBytes" to a Remote Config byte array represented by a numeric array - mBytes: [0xFF, 0x00] -} -// set defaults -window.FirebasePlugin.setDefaults(defaults); -// or, specify a namespace -window.FirebasePlugin.setDefaults(defaults, "namespace"); -``` - -## startTrace - -Start a trace. - -``` -window.FirebasePlugin.startTrace("test trace", success, error); -``` - -## incrementCounter - -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: - -``` -window.FirebasePlugin.incrementCounter("test trace", "retry", success, error); -``` - -## stopTrace - -Stop the trace - -``` -window.FirebasePlugin.stopTrace("test trace"); -``` - -## setAnalyticsCollectionEnabled - -Enable/disable analytics collection - -``` -window.FirebasePlugin.setAnalyticsCollectionEnabled(true); // Enables analytics collection - -window.FirebasePlugin.setAnalyticsCollectionEnabled(false); // Disables analytics collection -``` diff --git a/docs/GOOGLE_TAG_MANAGER.md b/docs/GOOGLE_TAG_MANAGER.md deleted file mode 100644 index 6be9a8a56..000000000 --- a/docs/GOOGLE_TAG_MANAGER.md +++ /dev/null @@ -1,16 +0,0 @@ -# Google Tag Manager -Download your container-config json file from Tag Manager and add a resource-file node in your `config.xml`. - -## Android -``` -
NSString and values must be NSNumber or NSString.
- * @discussion How we treat NSNumbers:
- * We will provide information about the distribution of values over time.
- *
- * How we treat NSStrings:
- * NSStrings are used as categorical data, allowing comparison across different category values.
- * Strings are limited to a maximum length of 100 characters, attributes over this length will be
- * truncated.
- *
- * When tracking the Tweet views to better understand user engagement, sending the tweet's length
- * and the type of media present in the tweet allows you to track how tweet length and the type of media influence
- * engagement.
- */
-+ (void)logCustomEventWithName:(NSString *)eventName
- customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil;
-
-@end
-
-NS_ASSUME_NONNULL_END
diff --git a/src/ios/Crashlytics/Crashlytics.framework/Headers/CLSAttributes.h b/src/ios/Crashlytics/Crashlytics.framework/Headers/CLSAttributes.h
deleted file mode 100644
index 1526b0dca..000000000
--- a/src/ios/Crashlytics/Crashlytics.framework/Headers/CLSAttributes.h
+++ /dev/null
@@ -1,33 +0,0 @@
-//
-// CLSAttributes.h
-// Crashlytics
-//
-// Copyright (c) 2015 Crashlytics, Inc. All rights reserved.
-//
-
-#pragma once
-
-#define CLS_DEPRECATED(x) __attribute__ ((deprecated(x)))
-
-#if !__has_feature(nullability)
- #define nonnull
- #define nullable
- #define _Nullable
- #define _Nonnull
-#endif
-
-#ifndef NS_ASSUME_NONNULL_BEGIN
- #define NS_ASSUME_NONNULL_BEGIN
-#endif
-
-#ifndef NS_ASSUME_NONNULL_END
- #define NS_ASSUME_NONNULL_END
-#endif
-
-#if __has_feature(objc_generics)
- #define CLS_GENERIC_NSARRAY(type) NSArray-
-///
- ad_activeview -///
- ad_click -///
- ad_exposure -///
- ad_impression -///
- ad_query -///
- adunit_exposure -///
- app_clear_data -///
- app_remove -///
- app_update -///
- error -///
- first_open -///
- in_app_purchase -///
- notification_dismiss -///
- notification_foreground -///
- notification_open -///
- notification_receive -///
- os_update -///
- screen_view -///
- session_start -///
- user_engagement -///
-
-///
- first_open_time -///
- last_deep_link_referrer -///
- user_id -///
-
-///
- @c kFIRParameterQuantity (signed 64-bit integer as NSNumber) -///
- @c kFIRParameterItemID (NSString) -///
- @c kFIRParameterItemName (NSString) -///
- @c kFIRParameterItemCategory (NSString) -///
- @c kFIRParameterItemLocationID (NSString) (optional) -///
- @c kFIRParameterPrice (double as NSNumber) (optional) -///
- @c kFIRParameterCurrency (NSString) (optional) -///
- @c kFIRParameterValue (double as NSNumber) (optional) -///
- @c kFIRParameterOrigin (NSString) (optional) -///
- @c kFIRParameterDestination (NSString) (optional) -///
- @c kFIRParameterStartDate (NSString) (optional) -///
- @c kFIRParameterEndDate (NSString) (optional) -///
-
-///
- @c kFIRParameterQuantity (signed 64-bit integer as NSNumber) -///
- @c kFIRParameterItemID (NSString) -///
- @c kFIRParameterItemName (NSString) -///
- @c kFIRParameterItemCategory (NSString) -///
- @c kFIRParameterItemLocationID (NSString) (optional) -///
- @c kFIRParameterPrice (double as NSNumber) (optional) -///
- @c kFIRParameterCurrency (NSString) (optional) -///
- @c kFIRParameterValue (double as NSNumber) (optional) -///
-
-///
- @c kFIRParameterValue (double as NSNumber) (optional) -///
- @c kFIRParameterCurrency (NSString) (optional) -///
- @c kFIRParameterTransactionID (NSString) (optional) -///
- @c kFIRParameterStartDate (NSString) (optional) -///
- @c kFIRParameterEndDate (NSString) (optional) -///
- @c kFIRParameterNumberOfNights (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings -///
- @c kFIRParameterNumberOfRooms (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings -///
- @c kFIRParameterNumberOfPassengers (signed 64-bit integer as NSNumber) (optional) -/// for travel bookings -///
- @c kFIRParameterOrigin (NSString) (optional) -///
- @c kFIRParameterDestination (NSString) (optional) -///
- @c kFIRParameterTravelClass (NSString) (optional) for travel bookings -///
-
-///
- @c kFIRParameterSource (NSString) -///
- @c kFIRParameterMedium (NSString) -///
- @c kFIRParameterCampaign (NSString) -///
- @c kFIRParameterTerm (NSString) (optional) -///
- @c kFIRParameterContent (NSString) (optional) -///
- @c kFIRParameterAdNetworkClickID (NSString) (optional) -///
- @c kFIRParameterCP1 (NSString) (optional) -///
-
-///
- @c kFIRParameterCheckoutStep (unsigned 64-bit integer as NSNumber) -///
- @c kFIRParameterCheckoutOption (NSString) (optional) -///
-
-///
- @c kFIRParameterVirtualCurrencyName (NSString) -///
- @c kFIRParameterValue (signed 64-bit integer or double as NSNumber) -///
-
-///
- @c kFIRParameterCurrency (NSString) (optional) -///
- @c kFIRParameterValue (double as NSNumber) (optional) -///
- @c kFIRParameterTransactionID (NSString) (optional) -///
- @c kFIRParameterTax (double as NSNumber) (optional) -///
- @c kFIRParameterShipping (double as NSNumber) (optional) -///
- @c kFIRParameterCoupon (NSString) (optional) -///
- @c kFIRParameterLocation (NSString) (optional) -///
- @c kFIRParameterStartDate (NSString) (optional) -///
- @c kFIRParameterEndDate (NSString) (optional) -///
- @c kFIRParameterNumberOfNights (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings -///
- @c kFIRParameterNumberOfRooms (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings -///
- @c kFIRParameterNumberOfPassengers (signed 64-bit integer as NSNumber) (optional) -/// for travel bookings -///
- @c kFIRParameterOrigin (NSString) (optional) -///
- @c kFIRParameterDestination (NSString) (optional) -///
- @c kFIRParameterTravelClass (NSString) (optional) for travel bookings -///
-
-///
- @c kFIRParameterCurrency (NSString) (optional) -///
- @c kFIRParameterValue (double as NSNumber) (optional) -///
-
-///
- @c kFIRParameterGroupID (NSString) -///
-
-///
- @c kFIRParameterLevel (signed 64-bit integer as NSNumber) -///
- @c kFIRParameterCharacter (NSString) (optional) -///
-
-///
- @c kFIRParameterScore (signed 64-bit integer as NSNumber) -///
- @c kFIRParameterLevel (signed 64-bit integer as NSNumber) (optional) -///
- @c kFIRParameterCharacter (NSString) (optional) -///
-
-///
- @c kFIRParameterQuantity (signed 64-bit integer as NSNumber) -///
- @c kFIRParameterItemID (NSString) -///
- @c kFIRParameterItemName (NSString) -///
- @c kFIRParameterItemCategory (NSString) -///
- @c kFIRParameterItemLocationID (NSString) (optional) -///
- @c kFIRParameterPrice (double as NSNumber) (optional) -///
- @c kFIRParameterCurrency (NSString) (optional) -///
- @c kFIRParameterValue (double as NSNumber) (optional) -///
-
-///
- @c kFIRParameterCurrency (NSString) (optional) -///
- @c kFIRParameterValue (double as NSNumber) (optional) -///
- @c kFIRParameterTransactionID (NSString) (optional) -///
-
-///
- @c kFIRParameterQuantity (signed 64-bit integer as NSNumber) -///
- @c kFIRParameterItemID (NSString) -///
- @c kFIRParameterItemName (NSString) -///
- @c kFIRParameterItemCategory (NSString) -///
- @c kFIRParameterItemLocationID (NSString) (optional) -///
- @c kFIRParameterPrice (double as NSNumber) (optional) -///
- @c kFIRParameterCurrency (NSString) (optional) -///
- @c kFIRParameterValue (double as NSNumber) (optional) -///
- @c kFIRParameterOrigin (NSString) (optional) -///
- @c kFIRParameterDestination (NSString) (optional) -///
- @c kFIRParameterStartDate (NSString) (optional) -///
- @c kFIRParameterEndDate (NSString) (optional) -///
-
-///
- @c kFIRParameterSearchTerm (NSString) -///
- @c kFIRParameterStartDate (NSString) (optional) -///
- @c kFIRParameterEndDate (NSString) (optional) -///
- @c kFIRParameterNumberOfNights (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings -///
- @c kFIRParameterNumberOfRooms (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings -///
- @c kFIRParameterNumberOfPassengers (signed 64-bit integer as NSNumber) (optional) -/// for travel bookings -///
- @c kFIRParameterOrigin (NSString) (optional) -///
- @c kFIRParameterDestination (NSString) (optional) -///
- @c kFIRParameterTravelClass (NSString) (optional) for travel bookings -///
-
-///
- @c kFIRParameterContentType (NSString) -///
- @c kFIRParameterItemID (NSString) -///
-
-///
- @c kFIRParameterCheckoutStep (unsigned 64-bit integer as NSNumber) -///
- @c kFIRParameterCheckoutOption (NSString) -///
-
-///
- @c kFIRParameterContentType (NSString) -///
- @c kFIRParameterItemID (NSString) -///
-
-///
- @c kFIRParameterSignUpMethod (NSString) -///
-
-///
- @c kFIRParameterItemName (NSString) -///
- @c kFIRParameterVirtualCurrencyName (NSString) -///
- @c kFIRParameterValue (signed 64-bit integer or double as NSNumber) -///
-
-///
- @c kFIRParameterAchievementID (NSString) -///
-
-///
- @c kFIRParameterItemID (NSString) -///
- @c kFIRParameterItemName (NSString) -///
- @c kFIRParameterItemCategory (NSString) -///
- @c kFIRParameterItemLocationID (NSString) (optional) -///
- @c kFIRParameterPrice (double as NSNumber) (optional) -///
- @c kFIRParameterQuantity (signed 64-bit integer as NSNumber) (optional) -///
- @c kFIRParameterCurrency (NSString) (optional) -///
- @c kFIRParameterValue (double as NSNumber) (optional) -///
- @c kFIRParameterStartDate (NSString) (optional) -///
- @c kFIRParameterEndDate (NSString) (optional) -///
- @c kFIRParameterFlightNumber (NSString) (optional) for travel bookings -///
- @c kFIRParameterNumberOfPassengers (signed 64-bit integer as NSNumber) (optional) -/// for travel bookings -///
- @c kFIRParameterNumberOfNights (signed 64-bit integer as NSNumber) (optional) for -/// travel bookings -///
- @c kFIRParameterNumberOfRooms (signed 64-bit integer as NSNumber) (optional) for -/// travel bookings -///
- @c kFIRParameterOrigin (NSString) (optional) -///
- @c kFIRParameterDestination (NSString) (optional) -///
- @c kFIRParameterSearchTerm (NSString) (optional) for travel bookings -///
- @c kFIRParameterTravelClass (NSString) (optional) for travel bookings -///
-
-///
- @c kFIRParameterItemCategory (NSString) -///
-
-///
- @c kFIRParameterSearchTerm (NSString) -///
-
-///
- @c kFIRParameterLevelName (NSString) -///
-
-///
- @c kFIRParameterLevelName (NSString) -///
- @c kFIRParameterSuccess (NSString) -///
-/// NSDictionary *params = @{
-/// kFIRParameterAchievementID : @"10_matches_won",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterAchievementID NS_SWIFT_NAME(AnalyticsParameterAchievementID) =
- @"achievement_id";
-
-/// Ad Network Click ID (NSString). Used for network-specific click IDs which vary in format.
-///
-/// NSDictionary *params = @{
-/// kFIRParameterAdNetworkClickID : @"1234567",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterAdNetworkClickID
- NS_SWIFT_NAME(AnalyticsParameterAdNetworkClickID) = @"aclid";
-
-/// The store or affiliation from which this transaction occurred (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterAffiliation : @"Google Store",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterAffiliation NS_SWIFT_NAME(AnalyticsParameterAffiliation) =
- @"affiliation";
-
-/// The individual campaign name, slogan, promo code, etc. Some networks have pre-defined macro to
-/// capture campaign information, otherwise can be populated by developer. Highly Recommended
-/// (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterCampaign : @"winter_promotion",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterCampaign NS_SWIFT_NAME(AnalyticsParameterCampaign) =
- @"campaign";
-
-/// Character used in game (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterCharacter : @"beat_boss",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterCharacter NS_SWIFT_NAME(AnalyticsParameterCharacter) =
- @"character";
-
-/// The checkout step (1..N) (unsigned 64-bit integer as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterCheckoutStep : @"1",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterCheckoutStep NS_SWIFT_NAME(AnalyticsParameterCheckoutStep) =
- @"checkout_step";
-
-/// Some option on a step in an ecommerce flow (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterCheckoutOption : @"Visa",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterCheckoutOption
- NS_SWIFT_NAME(AnalyticsParameterCheckoutOption) = @"checkout_option";
-
-/// Campaign content (NSString).
-static NSString *const kFIRParameterContent NS_SWIFT_NAME(AnalyticsParameterContent) = @"content";
-
-/// Type of content selected (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterContentType : @"news article",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterContentType NS_SWIFT_NAME(AnalyticsParameterContentType) =
- @"content_type";
-
-/// Coupon code for a purchasable item (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterCoupon : @"zz123",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterCoupon NS_SWIFT_NAME(AnalyticsParameterCoupon) = @"coupon";
-
-/// Campaign custom parameter (NSString). Used as a method of capturing custom data in a campaign.
-/// Use varies by network.
-///
-/// NSDictionary *params = @{
-/// kFIRParameterCP1 : @"custom_data",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterCP1 NS_SWIFT_NAME(AnalyticsParameterCP1) = @"cp1";
-
-/// The name of a creative used in a promotional spot (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterCreativeName : @"Summer Sale",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterCreativeName NS_SWIFT_NAME(AnalyticsParameterCreativeName) =
- @"creative_name";
-
-/// The name of a creative slot (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterCreativeSlot : @"summer_banner2",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterCreativeSlot NS_SWIFT_NAME(AnalyticsParameterCreativeSlot) =
- @"creative_slot";
-
-/// Purchase currency in 3-letter
-/// ISO_4217 format (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterCurrency : @"USD",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterCurrency NS_SWIFT_NAME(AnalyticsParameterCurrency) =
- @"currency";
-
-/// Flight or Travel destination (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterDestination : @"Mountain View, CA",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterDestination NS_SWIFT_NAME(AnalyticsParameterDestination) =
- @"destination";
-
-/// The arrival date, check-out date or rental end date for the item. This should be in
-/// YYYY-MM-DD format (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterEndDate : @"2015-09-14",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterEndDate NS_SWIFT_NAME(AnalyticsParameterEndDate) = @"end_date";
-
-/// Flight number for travel events (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterFlightNumber : @"ZZ800",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterFlightNumber NS_SWIFT_NAME(AnalyticsParameterFlightNumber) =
- @"flight_number";
-
-/// Group/clan/guild ID (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterGroupID : @"g1",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterGroupID NS_SWIFT_NAME(AnalyticsParameterGroupID) = @"group_id";
-
-/// Index of an item in a list (signed 64-bit integer as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterIndex : @(1),
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterIndex NS_SWIFT_NAME(AnalyticsParameterIndex) = @"index";
-
-/// Item brand (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterItemBrand : @"Google",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterItemBrand NS_SWIFT_NAME(AnalyticsParameterItemBrand) =
- @"item_brand";
-
-/// Item category (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterItemCategory : @"t-shirts",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterItemCategory NS_SWIFT_NAME(AnalyticsParameterItemCategory) =
- @"item_category";
-
-/// Item ID (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterItemID : @"p7654",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterItemID NS_SWIFT_NAME(AnalyticsParameterItemID) = @"item_id";
-
-/// The Google Place ID (NSString) that
-/// corresponds to the associated item. Alternatively, you can supply your own custom Location ID.
-///
-/// NSDictionary *params = @{
-/// kFIRParameterItemLocationID : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterItemLocationID
- NS_SWIFT_NAME(AnalyticsParameterItemLocationID) = @"item_location_id";
-
-/// Item name (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterItemName : @"abc",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterItemName NS_SWIFT_NAME(AnalyticsParameterItemName) =
- @"item_name";
-
-/// The list in which the item was presented to the user (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterItemList : @"Search Results",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterItemList NS_SWIFT_NAME(AnalyticsParameterItemList) =
- @"item_list";
-
-/// Item variant (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterItemVariant : @"Red",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterItemVariant NS_SWIFT_NAME(AnalyticsParameterItemVariant) =
- @"item_variant";
-
-/// Level in game (signed 64-bit integer as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterLevel : @(42),
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterLevel NS_SWIFT_NAME(AnalyticsParameterLevel) = @"level";
-
-/// Location (NSString). The Google Place ID
-/// that corresponds to the associated event. Alternatively, you can supply your own custom
-/// Location ID.
-///
-/// NSDictionary *params = @{
-/// kFIRParameterLocation : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterLocation NS_SWIFT_NAME(AnalyticsParameterLocation) =
- @"location";
-
-/// The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended
-/// (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterMedium : @"email",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterMedium NS_SWIFT_NAME(AnalyticsParameterMedium) = @"medium";
-
-/// Number of nights staying at hotel (signed 64-bit integer as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterNumberOfNights : @(3),
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterNumberOfNights
- NS_SWIFT_NAME(AnalyticsParameterNumberOfNights) = @"number_of_nights";
-
-/// Number of passengers traveling (signed 64-bit integer as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterNumberOfPassengers : @(11),
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterNumberOfPassengers
- NS_SWIFT_NAME(AnalyticsParameterNumberOfPassengers) = @"number_of_passengers";
-
-/// Number of rooms for travel events (signed 64-bit integer as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterNumberOfRooms : @(2),
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterNumberOfRooms NS_SWIFT_NAME(AnalyticsParameterNumberOfRooms) =
- @"number_of_rooms";
-
-/// Flight or Travel origin (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterOrigin : @"Mountain View, CA",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterOrigin NS_SWIFT_NAME(AnalyticsParameterOrigin) = @"origin";
-
-/// Purchase price (double as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterPrice : @(1.0),
-/// kFIRParameterCurrency : @"USD", // e.g. $1.00 USD
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterPrice NS_SWIFT_NAME(AnalyticsParameterPrice) = @"price";
-
-/// Purchase quantity (signed 64-bit integer as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterQuantity : @(1),
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterQuantity NS_SWIFT_NAME(AnalyticsParameterQuantity) =
- @"quantity";
-
-/// Score in game (signed 64-bit integer as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterScore : @(4200),
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterScore NS_SWIFT_NAME(AnalyticsParameterScore) = @"score";
-
-/// The search string/keywords used (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterSearchTerm : @"periodic table",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterSearchTerm NS_SWIFT_NAME(AnalyticsParameterSearchTerm) =
- @"search_term";
-
-/// Shipping cost (double as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterShipping : @(9.50),
-/// kFIRParameterCurrency : @"USD", // e.g. $9.50 USD
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterShipping NS_SWIFT_NAME(AnalyticsParameterShipping) =
- @"shipping";
-
-/// Sign up method (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterSignUpMethod : @"google",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterSignUpMethod NS_SWIFT_NAME(AnalyticsParameterSignUpMethod) =
- @"sign_up_method";
-
-/// The origin of your traffic, such as an Ad network (for example, google) or partner (urban
-/// airship). Identify the advertiser, site, publication, etc. that is sending traffic to your
-/// property. Highly recommended (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterSource : @"InMobi",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterSource NS_SWIFT_NAME(AnalyticsParameterSource) = @"source";
-
-/// The departure date, check-in date or rental start date for the item. This should be in
-/// YYYY-MM-DD format (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterStartDate : @"2015-09-14",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterStartDate NS_SWIFT_NAME(AnalyticsParameterStartDate) =
- @"start_date";
-
-/// Tax amount (double as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterTax : @(1.0),
-/// kFIRParameterCurrency : @"USD", // e.g. $1.00 USD
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterTax NS_SWIFT_NAME(AnalyticsParameterTax) = @"tax";
-
-/// If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword
-/// (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterTerm : @"game",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterTerm NS_SWIFT_NAME(AnalyticsParameterTerm) = @"term";
-
-/// A single ID for a ecommerce group transaction (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterTransactionID : @"ab7236dd9823",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterTransactionID NS_SWIFT_NAME(AnalyticsParameterTransactionID) =
- @"transaction_id";
-
-/// Travel class (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterTravelClass : @"business",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterTravelClass NS_SWIFT_NAME(AnalyticsParameterTravelClass) =
- @"travel_class";
-
-/// A context-specific numeric value which is accumulated automatically for each event type. This is
-/// a general purpose parameter that is useful for accumulating a key metric that pertains to an
-/// event. Examples include revenue, distance, time and points. Value should be specified as signed
-/// 64-bit integer or double as NSNumber. Notes: Values for pre-defined currency-related events
-/// (such as @c kFIREventAddToCart) should be supplied using double as NSNumber and must be
-/// accompanied by a @c kFIRParameterCurrency parameter. The valid range of accumulated values is
-/// [-9,223,372,036,854.77, 9,223,372,036,854.77]. Supplying a non-numeric value, omitting the
-/// corresponding @c kFIRParameterCurrency parameter, or supplying an invalid
-/// currency code for conversion events will cause that
-/// conversion to be omitted from reporting.
-///
-/// NSDictionary *params = @{
-/// kFIRParameterValue : @(3.99),
-/// kFIRParameterCurrency : @"USD", // e.g. $3.99 USD
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterValue NS_SWIFT_NAME(AnalyticsParameterValue) = @"value";
-
-/// Name of virtual currency type (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterVirtualCurrencyName : @"virtual_currency_name",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterVirtualCurrencyName
- NS_SWIFT_NAME(AnalyticsParameterVirtualCurrencyName) = @"virtual_currency_name";
-
-/// The name of a level in a game (NSString).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterLevelName : @"room_1",
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterLevelName NS_SWIFT_NAME(AnalyticsParameterLevelName) =
- @"level_name";
-
-/// The result of an operation. Specify 1 to indicate success and 0 to indicate failure (unsigned
-/// integer as NSNumber).
-///
-/// NSDictionary *params = @{
-/// kFIRParameterSuccess : @(1),
-/// // ...
-/// };
-///
-static NSString *const kFIRParameterSuccess NS_SWIFT_NAME(AnalyticsParameterSuccess) = @"success";
diff --git a/src/ios/Firebase/Analytics/FirebaseAnalytics.framework/Headers/FIRUserPropertyNames.h b/src/ios/Firebase/Analytics/FirebaseAnalytics.framework/Headers/FIRUserPropertyNames.h
deleted file mode 100755
index f50707fa1..000000000
--- a/src/ios/Firebase/Analytics/FirebaseAnalytics.framework/Headers/FIRUserPropertyNames.h
+++ /dev/null
@@ -1,17 +0,0 @@
-/// @file FIRUserPropertyNames.h
-///
-/// Predefined user property names.
-///
-/// A UserProperty is an attribute that describes the app-user. By supplying UserProperties, you can
-/// later analyze different behaviors of various segments of your userbase. You may supply up to 25
-/// unique UserProperties per app, and you can use the name and value of your choosing for each one.
-/// UserProperty names can be up to 24 characters long, may only contain alphanumeric characters and
-/// underscores ("_"), and must start with an alphabetic character. UserProperty values can be up to
-/// 36 characters long. The "firebase_", "google_", and "ga_" prefixes are reserved and should not
-/// be used.
-
-#import