cordova-acoustic-mobile-push-plugin-inbox/www/ts/MCEInboxPlugin.ts

Inbox Action for Acoustic MCE Push Services

/*
 * Copyright © 2011, 2019 Acoustic, L.P. All rights reserved.
 *
 * NOTICE: This file contains material that is confidential and proprietary to
 * Acoustic, L.P. and/or other developers. No license is granted under any intellectual or
 * industrial property rights of Acoustic, L.P. except as may be provided in an agreement with
 * Acoustic, L.P. Any unauthorized copying or distribution of content from this file is
 * prohibited.
 */

import { StringObject } from "cordova-acoustic-mobile-push/www/js/MCEPluginTypes";
import { InboxListCallback, InboxMessageCallback } from "./MCEInboxPluginTypes";

/**
Acoustic MCE Inbox Cordova Plugin
*/
namespace MCEInboxPlugin {
        if (window.cordova.platformId !== 'ios') {
            cordova.exec(null, null, "MCEInboxPlugin", "initialize", []);
        }

    /**
    Allow Cordova Inbox Plugin to respond to changes in the inbox list.
    @param {InboxListCallback} callback The callback that handles the response
    */
    export const setInboxMessagesUpdateCallback = function (
        callback: InboxListCallback
    ) {
        MCEPlugin.pauseResumeCallback(
            function () {
                cordova.exec(
                    callback,
                    MCEPlugin.error,
                    "MCEInboxPlugin",
                    "setInboxMessagesUpdateCallback",
                    [false]
                );
            },
            function () {
                cordova.exec(
                    callback,
                    MCEPlugin.error,
                    "MCEInboxPlugin",
                    "setInboxMessagesUpdateCallback",
                    [true]
                );
            }
        );
    };

    /**
    Allows Cordova Inbox Plugin to initiate a sync with the server. Will execute function
    registered with setInboxMessagesUpdateCallback when complete.
    */
    export const syncInboxMessages = function () {
        cordova.exec(
            null,
            MCEPlugin.error,
            "MCEInboxPlugin",
            "syncInboxMessages",
            []
        );
    };

    /**
    Allows Cordova Inbox Plugin to get the inbox message by providing the inbox message id.
    @param {string} inboxMessageId Unique identifier for inbox message
    @param {InboxMessageCallback} callback  The callback that handles the response
    */
    export const fetchInboxMessageId = function (
        inboxMessageId: string,
        callback: InboxMessageCallback
    ) {
        cordova.exec(
            callback,
            MCEPlugin.error,
            "MCEInboxPlugin",
            "fetchInboxMessageId",
            [inboxMessageId]
        );
    };

    /**
    Allows Cordova Inbox Plugin to call out to action registry to handle rich message actions.
    @param {Object} action is normally in the format { "type": <type>, "value": <value> } but can be whatever is sent in the "notification-action" or the "category-actions" section of the payload
    */
    export const executeInboxAction = function (
        action: StringObject,
        inboxMessageId: string
    ) {
        cordova.exec(null, MCEPlugin.error, "MCEInboxPlugin", "executeInboxAction", [
            action,
            inboxMessageId,
        ]);
    };

    /**
    Allows Cordova Inbox Plugin to delete a message from the database cache and server.
    @param {string} inboxMessageId Unique identifier for inbox message
    */
    export const deleteMessageId = function (inboxMessageId: string) {
        cordova.exec(null, MCEPlugin.error, "MCEInboxPlugin", "deleteMessageId", [
            inboxMessageId,
        ]);
    };

    /**
    Allows Cordova Inbox Plugin to set the read status of a message in the database cache and server.
    @param {string} inboxMessageId Unique identifier for inbox message
    */
    export const readMessageId = function (inboxMessageId: string) {
        cordova.exec(null, MCEPlugin.error, "MCEInboxPlugin", "readMessageId", [
            inboxMessageId,
        ]);
    };

    /**
    Allows Cordova Inbox Plugin to retrieve an inbox message by providing a richContentId.
    @param {string} richContentId Unique identifier for rich content
    @param {InboxMessageCallback} callback The callback that handles the response
    */
    export const fetchInboxMessageViaRichContentId = function (
        richContentId: string,
        callback: InboxMessageCallback
    ) {
        cordova.exec(
            callback,
            MCEPlugin.error,
            "MCEInboxPlugin",
            "fetchInboxMessageViaRichContentId",
            [richContentId]
        );
    };

    /**
    Allows Cordova Inbox Plugin to immediately remove expired messages from the inbox database
    */
    export const clearExpiredMessages = function () {
        cordova.exec(
            null,
            MCEPlugin.error,
            "MCEInboxPlugin",
            "clearExpiredMessages",
            []
        );
    };
}

export = MCEInboxPlugin;