onesignal-cordova-plugin/www/InAppMessagesNamespace.ts

OneSignal is a high volume Push Notification service for mobile apps. In addition to basic notification delivery, OneSignal also provides tools to localize, target, schedule, and automate notifications that you send.

import {
  InAppMessageClickEvent,
  InAppMessageDidDismissEvent,
  InAppMessageDidDisplayEvent,
  InAppMessageEventName,
  InAppMessageEventTypeMap,
  InAppMessageWillDismissEvent,
  InAppMessageWillDisplayEvent,
} from "./models/InAppMessage";

export default class InAppMessages {
  private _inAppMessageClickListeners: ((
    action: InAppMessageClickEvent
  ) => void)[] = [];
  private _willDisplayInAppMessageListeners: ((
    event: InAppMessageWillDisplayEvent
  ) => void)[] = [];
  private _didDisplayInAppMessageListeners: ((
    event: InAppMessageDidDisplayEvent
  ) => void)[] = [];
  private _willDismissInAppMessageListeners: ((
    event: InAppMessageWillDismissEvent
  ) => void)[] = [];
  private _didDismissInAppMessageListeners: ((
    event: InAppMessageDidDismissEvent
  ) => void)[] = [];

  private _processFunctionList<T>(
    array: ((event: T) => void)[],
    param: T
  ): void {
    for (let i = 0; i < array.length; i++) {
      array[i](param);
    }
  }

  /**
   * Add event listeners for In-App Message click and/or lifecycle events.
   * @param event
   * @param listener
   * @returns
   */
  addEventListener<K extends InAppMessageEventName>(
    event: K,
    listener: (event: InAppMessageEventTypeMap[K]) => void
  ): void {
    if (event === "click") {
      this._inAppMessageClickListeners.push(
        listener as (event: InAppMessageClickEvent) => void
      );
      const inAppMessageClickListener = (json: InAppMessageClickEvent) => {
        this._processFunctionList(this._inAppMessageClickListeners, json);
      };
      window.cordova.exec(
        inAppMessageClickListener,
        function () {},
        "OneSignalPush",
        "setInAppMessageClickHandler",
        []
      );
    } else if (event === "willDisplay") {
      this._willDisplayInAppMessageListeners.push(
        listener as (event: InAppMessageWillDisplayEvent) => void
      );
      const willDisplayCallBackProcessor = (
        event: InAppMessageWillDisplayEvent
      ) => {
        this._processFunctionList(
          this._willDisplayInAppMessageListeners,
          event
        );
      };
      window.cordova.exec(
        willDisplayCallBackProcessor,
        function () {},
        "OneSignalPush",
        "setOnWillDisplayInAppMessageHandler",
        []
      );
    } else if (event === "didDisplay") {
      this._didDisplayInAppMessageListeners.push(
        listener as (event: InAppMessageDidDisplayEvent) => void
      );
      const didDisplayCallBackProcessor = (
        event: InAppMessageDidDisplayEvent
      ) => {
        this._processFunctionList(this._didDisplayInAppMessageListeners, event);
      };
      window.cordova.exec(
        didDisplayCallBackProcessor,
        function () {},
        "OneSignalPush",
        "setOnDidDisplayInAppMessageHandler",
        []
      );
    } else if (event === "willDismiss") {
      this._willDismissInAppMessageListeners.push(
        listener as (event: InAppMessageWillDismissEvent) => void
      );
      const willDismissInAppMessageProcessor = (
        event: InAppMessageWillDismissEvent
      ) => {
        this._processFunctionList(
          this._willDismissInAppMessageListeners,
          event
        );
      };
      window.cordova.exec(
        willDismissInAppMessageProcessor,
        function () {},
        "OneSignalPush",
        "setOnWillDismissInAppMessageHandler",
        []
      );
    } else if (event === "didDismiss") {
      this._didDismissInAppMessageListeners.push(
        listener as (event: InAppMessageDidDismissEvent) => void
      );
      const didDismissInAppMessageCallBackProcessor = (
        event: InAppMessageDidDismissEvent
      ) => {
        this._processFunctionList(this._didDismissInAppMessageListeners, event);
      };
      window.cordova.exec(
        didDismissInAppMessageCallBackProcessor,
        function () {},
        "OneSignalPush",
        "setOnDidDismissInAppMessageHandler",
        []
      );
    } else {
      return;
    }
  }

  /**
   * Remove event listeners for In-App Message click and/or lifecycle events.
   * @param event
   * @param listener
   * @returns
   */
  removeEventListener<K extends InAppMessageEventName>(
    event: K,
    listener: (obj: InAppMessageEventTypeMap[K]) => void
  ): void {
    if (event === "click") {
      const index = this._inAppMessageClickListeners.indexOf(listener);
      if (index !== -1) {
        this._inAppMessageClickListeners.splice(index, 1);
      }
    } else {
      if (event === "willDisplay") {
        let index = this._willDisplayInAppMessageListeners.indexOf(
          listener as (event: InAppMessageWillDisplayEvent) => void
        );
        if (index !== -1) {
          this._willDisplayInAppMessageListeners.splice(index, 1);
        }
      } else if (event === "didDisplay") {
        let index = this._didDisplayInAppMessageListeners.indexOf(
          listener as (event: InAppMessageDidDisplayEvent) => void
        );
        if (index !== -1) {
          this._willDisplayInAppMessageListeners.splice(index, 1);
        }
      } else if (event === "willDismiss") {
        let index = this._willDismissInAppMessageListeners.indexOf(
          listener as (event: InAppMessageWillDismissEvent) => void
        );
        if (index !== -1) {
          this._willDismissInAppMessageListeners.splice(index, 1);
        }
      } else if (event === "didDismiss") {
        let index = this._didDismissInAppMessageListeners.indexOf(
          listener as (event: InAppMessageDidDismissEvent) => void
        );
        if (index !== -1) {
          this._didDismissInAppMessageListeners.splice(index, 1);
        }
      } else {
        return;
      }
    }
  }

  /**
   * Add a trigger for the current user. Triggers are currently explicitly used to determine whether a specific IAM should be displayed to the user.
   * @param  {string} key
   * @param  {string} value
   * @returns void
   */
  addTrigger(key: string, value: string): void {
    const obj = { [key]: value };
    this.addTriggers(obj);
  }

  /**
   * Add multiple triggers for the current user. Triggers are currently explicitly used to determine whether a specific IAM should be displayed to the user.
   * @param  {[key: string]: string} triggers
   * @returns void
   */

  addTriggers(triggers: { [key: string]: string }): void {
    Object.keys(triggers).forEach(function (key) {
      // forces values to be string types
      if (typeof triggers[key] !== "string") {
        triggers[key] = JSON.stringify(triggers[key]);
      }
    });

    window.cordova.exec(
      function () {},
      function () {},
      "OneSignalPush",
      "addTriggers",
      [triggers]
    );
  }

  /**
   * Remove the trigger with the provided key from the current user.
   * @param  {string} key
   * @returns void
   */
  removeTrigger(key: string): void {
    this.removeTriggers([key]);
  }

  /**
   * Remove multiple triggers from the current user.
   * @param  {string[]} keys
   * @returns void
   */
  removeTriggers(keys: string[]): void {
    if (!Array.isArray(keys)) {
      console.error(
        "OneSignal: removeTriggers: argument must be of type Array"
      );
    }

    window.cordova.exec(
      function () {},
      function () {},
      "OneSignalPush",
      "removeTriggers",
      [keys]
    );
  }

  /**
   * Clear all triggers from the current user.
   * @returns void
   */
  clearTriggers(): void {
    window.cordova.exec(
      function () {},
      function () {},
      "OneSignalPush",
      "clearTriggers"
    );
  }

  /**
   * Set whether in-app messaging is currently paused.
   * When set to true no IAM will be presented to the user regardless of whether they qualify for them.
   * When set to 'false` any IAMs the user qualifies for will be presented to the user at the appropriate time.
   * @param  {boolean} pause
   * @returns void
   */
  setPaused(pause: boolean): void {
    window.cordova.exec(
      function () {},
      function () {},
      "OneSignalPush",
      "setPaused",
      [pause]
    );
  }

  /**
   * Whether in-app messaging is currently paused.
   * @returns {Promise<boolean>}
   */
  getPaused(): Promise<boolean> {
    return new Promise<boolean>((resolve, reject) => {
      window.cordova.exec(resolve, reject, "OneSignalPush", "isPaused", []);
    });
  }
}