Add support for In-App Messaging event triggers #1285

Author: EddyVerbruggen

demo-vue/package.json

@@ -7,17 +7,17 @@
   "nativescript": {
     "id": "org.nativescript.firebasedemo.firestore",
     "tns-ios": {
-      "version": "5.0.0"
+      "version": "6.0.1"
     },
     "tns-android": {
-      "version": "5.0.0"
+      "version": "6.0.0"
     }
   },
   "dependencies": {
     "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-9.1.0.tgz",
-    "nativescript-theme-core": "^1.0.4",
-    "nativescript-vue": "^2.0.0",
-    "tns-core-modules": "^5.0.2"
+    "nativescript-theme-core": "~1.0.6",
+    "nativescript-vue": "~2.4.0",
+    "tns-core-modules": "~6.0.0"
   },
   "devDependencies": {
     "@babel/core": "^7.0.0",

docs/IN_APP_MESSAGING.md

@@ -42,3 +42,17 @@ inappmessaging.onMessageImpression(message => {
   console.log("A message belonging to this campaign is being shown: " + message.campaignName);
 });
 ```
+
+### `triggerEvent`
+Trigger in-app messages programmatically.
+
+Firebase In-App Messaging by default allows you to trigger in-app messages with Google Analytics for Firebase events, with no additional integration. You can also manually trigger events programmatically with the Firebase In-App Messaging SDK’s programmatic triggers.
+
+In the In-App Messaging campaign composer, create a new campaign or select an existing campaign, and in the Scheduling step of the composer workflow, note the event ID of a newly-created or existing messaging event. Once noted, instrument your app to trigger the event by its ID.
+
+```typescript
+import { inappmessaging } from "nativescript-plugin-firebase/inappmessaging";
+
+const eventName = "myEvent";
+inappmessaging.triggerEvent(eventName);
+```

src/functions/functions.d.ts

@@ -1,2 +1,3 @@
-export declare type HttpsCallable<I, O> = ( callableData: I ) => Promise<O>;
+export declare type HttpsCallable<I, O> = (callableData: I) => Promise<O>;
+
 export declare function httpsCallable<I = {}, O = {}>(functionName: string): HttpsCallable<I, O>;

src/inappmessaging/inappmessaging.android.ts

@@ -23,3 +23,7 @@ export function onMessageImpression(callback: (data: OnMessageImpressionCallback
 
   com.google.firebase.inappmessaging.FirebaseInAppMessaging.getInstance().addImpressionListener(listener)
 }
+
+export function triggerEvent(eventName: string): void {
+  com.google.firebase.inappmessaging.FirebaseInAppMessaging.getInstance().triggerEvent(eventName);
+}

src/inappmessaging/inappmessaging.d.ts

@@ -10,4 +10,6 @@ export interface OnMessageClickedCallbackData {
 
 export declare function onMessageImpression(callback: (data: OnMessageImpressionCallbackData) => void): void;
 
-export declare function onMessageClicked(callback: (data: OnMessageClickedCallbackData) => void): void;
+export declare function onMessageClicked(callback: (data: OnMessageClickedCallbackData) => void): void;
+
+export declare function triggerEvent(eventName: string): void;

src/inappmessaging/inappmessaging.ios.ts

@@ -12,6 +12,10 @@ export function onMessageImpression(callback: (data: OnMessageImpressionCallback
   _firInAppMessagingDisplayDelegate.setOnMessageImpressionCallback(callback);
 }
 
+export function triggerEvent(eventName: string): void {
+  FIRInAppMessaging.inAppMessaging().triggerEvent(eventName);
+}
+
 function ensureDelegate(): void {
   if (!_firInAppMessagingDisplayDelegate) {
     FIRInAppMessaging.inAppMessaging().delegate = _firInAppMessagingDisplayDelegate = FIRInAppMessagingDisplayDelegateImpl.new();

src/package.json

@@ -46,13 +46,12 @@
     "demo-push.ios.release": "npm run preparedemo-push && cd ../demo-push && tns build ios --release --for-device",
     "demo-push.ios.eddy.iphoneX": "npm run preparedemo-push && cd ../demo-push && tns run ios --device a4cbb499e279054b55c206528f8510ff7fbf20c8",
     "demo.android": "npm run preparedemo && cd ../demo && rimraf platforms/android && tns run android",
-    "demo.android.linked": "npm run tsc && cd ../demo && tns run android --syncAllFiles",
     "demo-ng.android": "npm run preparedemo-ng && cd ../demo-ng && tns run android",
     "demo-ng.android.build": "npm run preparedemo-ng && cd ../demo-ng && tns build android",
     "demo-ng.android.bundled": "npm run preparedemo-ng && cd ../demo-ng && tns run android --bundle",
     "demo-push.android": "npm run preparedemo-push && cd ../demo-push && tns run android",
-    "demo-vue.ios": "npm run preparedemo-vue && cd ../demo-vue && tns run ios --bundle --syncAllFiles",
-    "demo-vue.android": "npm run preparedemo-vue && cd ../demo-vue && tns run android --bundle --syncAllFiles",
+    "demo-vue.ios": "npm run preparedemo-vue && cd ../demo-vue && tns run ios --bundle",
+    "demo-vue.android": "npm run preparedemo-vue && cd ../demo-vue && tns run android --bundle",
     "test": "npm run tslint && npm run tslint.demo && cd ../demo && tns build ios && tns build android",
     "test.ios": "cd ../demo && tns test ios --emulator",
     "test.ios.device": "cd ../demo && tns platform remove ios && tns test ios",