Module: MCEInboxPlugin

Acoustic MCE Inbox Cordova Plugin
Source:

Methods

(static) clearExpiredMessages()

Allows Cordova Inbox Plugin to immediately remove expired messages from the inbox database
Source:

(static) deleteMessageId(inboxMessageId)

Allows Cordova Inbox Plugin to delete a message from the database cache and server.
Parameters:
Name Type Description
inboxMessageId string Unique identifier for inbox message
Source:

(static) executeInboxAction(action)

Allows Cordova Inbox Plugin to call out to action registry to handle rich message actions.
Parameters:
Name Type Description
action Object 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
Source:

(static) fetchInboxMessageId(inboxMessageId, callback)

Allows Cordova Inbox Plugin to get the inbox message by providing the inbox message id.
Parameters:
Name Type Description
inboxMessageId string Unique identifier for inbox message
callback inboxMessageCallback The callback that handles the response
Source:

(static) fetchInboxMessageViaRichContentId(richContentId, callback)

Allows Cordova Inbox Plugin to retrieve an inbox message by providing a richContentId.
Parameters:
Name Type Description
richContentId string Unique identifier for rich content
callback inboxMessageCallback The callback that handles the response
Source:

(static) readMessageId(inboxMessageId)

Allows Cordova Inbox Plugin to set the read status of a message in the database cache and server.
Parameters:
Name Type Description
inboxMessageId string Unique identifier for inbox message
Source:

(static) setInboxMessagesUpdateCallback(callback)

Allow Cordova Inbox Plugin to respond to changes in the inbox list.
Parameters:
Name Type Description
callback inboxListCallback The callback that handles the response
Source:

(static) syncInboxMessages()

Allows Cordova Inbox Plugin to initiate a sync with the server. Will execute function registered with setInboxMessagesUpdateCallback when complete.
Source:

Type Definitions

inboxListCallback(messages)

Parameters:
Name Type Description
messages Array.<InboxMessage> Messages in Inbox
Source:

InboxMessage

Properties:
Name Type Description
inboxMessageId string Unique identifier for inbox message
richContentId string Unique identifier for rich content
expirationDate integer Expiration of message in seconds since epoch
sendDate integer Message sent date in seconds since epoch
template string Template name that handles display of this message
attribution string Campaign name message was sent with
isRead boolean True for message read, false for message unread
isDeleted boolean True for message deleted, false for message not deleted
Source:

inboxMessageCallback(messages)

Parameters:
Name Type Description
messages InboxMessage Inbox message contents
Source: