getAppInstanceId

README.md

@@ -30,6 +30,7 @@
     - [setEnabled](#setenabled)
     - [setUserId](#setuserid)
     - [setUserProperty](#setuserproperty)
+    - [getAppInstanceId](#getappinstanceid)
 
 <!-- /MarkdownTOC -->
 
@@ -276,3 +277,21 @@ cordova.plugins.firebase.analytics.setUserProperty("name1", "value1");
 `Promise`<`void`\>
 
 Callback when operation is completed
+
+### getAppInstanceId
+
+**getAppInstanceId**(): `Promise`<`string`\>
+
+Returns app instance identifier from Firebase.
+
+**`Example`**
+
+```ts
+cordova.plugins.firebase.analytics.getAppInstanceId();
+```
+
+#### Returns
+
+`Promise`<`string`\>
+
+Callback when operation is completed

src/android/FirebaseAnalyticsPlugin.java

@@ -82,6 +82,18 @@ protected void setDefaultEventParameters(CordovaArgs args, CallbackContext callb
         callbackContext.success();
     }
 
+    @CordovaMethod
+    protected void getAppInstanceId(CordovaArgs args, CallbackContext callbackContext) {
+        firebaseAnalytics.getAppInstanceId()
+            .addOnCompleteListener(task -> {
+                if (task.isSuccessful()) {
+                    callbackContext.success(task.getResult());
+                } else {
+                    callbackContext.error(task.getException().getMessage());
+                }
+            });
+    }
+
     private static Bundle parse(JSONObject params) throws JSONException {
         Bundle bundle = new Bundle();
         Iterator<String> it = params.keys();

src/ios/FirebaseAnalyticsPlugin.h

@@ -9,5 +9,6 @@
 - (void)setCurrentScreen:(CDVInvokedUrlCommand*)command;
 - (void)resetAnalyticsData:(CDVInvokedUrlCommand*)command;
 - (void)setDefaultEventParameters:(CDVInvokedUrlCommand*)command;
+- (void)getAppInstanceId:(CDVInvokedUrlCommand*)command;
 
 @end

src/ios/FirebaseAnalyticsPlugin.m

@@ -78,4 +78,11 @@ - (void)setDefaultEventParameters:(CDVInvokedUrlCommand *)command {
     [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
 }
 
+- (void)getAppInstanceId:(CDVInvokedUrlCommand *)command {
+    NSString* appInstanceId = [FIRAnalytics appInstanceID];
+
+    CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:appInstanceId];
+    [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
+}
+
 @end

types/FirebaseAnalytics.d.ts

@@ -72,3 +72,12 @@ export function setCurrentScreen(screenName: string): Promise<void>;
  * cordova.plugins.firebase.analytics.setDefaultEventParameters({foo: "bar"});
  */
 export function setDefaultEventParameters(defaults: Record<string, number | string | Array<object>>): Promise<void>;
+/**
+ * Returns app instance identifier from Firebase.
+ *
+ * @returns {Promise<string>} Callback when operation is completed
+ *
+ * @example
+ * cordova.plugins.firebase.analytics.getAppInstanceId();
+ */
+export function getAppInstanceId(): Promise<string>;

www/FirebaseAnalytics.js

@@ -117,3 +117,18 @@ function(defaults) {
         exec(resolve, reject, PLUGIN_NAME, "setDefaultEventParameters", [defaults || {}]);
     });
 };
+
+exports.getAppInstanceId =
+/**
+ * Returns app instance identifier from Firebase.
+ *
+ * @returns {Promise<string>} Callback when operation is completed
+ *
+ * @example
+ * cordova.plugins.firebase.analytics.getAppInstanceId();
+ */
+function() {
+    return new Promise(function(resolve, reject) {
+        exec(resolve, reject, PLUGIN_NAME, "getAppInstanceId", []);
+    });
+};