Class: RemoteMessage

remotemessage.RemoteMessage()

new RemoteMessage()

Source:

Methods

(static) RemoteMessage#getAttachment() → {String}

Get the field value The encoded attachment.
Source:
Returns:
Type
String

(static) RemoteMessage#getAttachmentEncoding() → {String}

Get the field value The type of encoding used for the attachment, typically BASE64.
Source:
Returns:
Type
String

(static) RemoteMessage#getAttachmentUri() → {String}

Get the field value The attachment URI.
Source:
Returns:
Type
String

(static) RemoteMessage#getFragmentIndex() → {Number}

Get the field value The order of fragments when message is split for large attachments.
Source:
Returns:
must be an integer
Type
Number

(static) RemoteMessage#getId() → {String}

Get the field value Identifier for the message
Source:
Returns:
Type
String

(static) RemoteMessage#getLastFragment() → {Boolean}

Get the field value If this is the final fragment in a series.
Source:
Returns:
Type
Boolean

(static) RemoteMessage#getMethod() → {remotemessage.Method}

Get the field value The name of the business message being sent
Source:
Returns:
Type
remotemessage.Method

(static) RemoteMessage#getPackageName() → {String}

Get the field value The package name of the sending Clover api
Source:
Returns:
Type
String

(static) RemoteMessage#getPayload() → {String}

Get the field value The payload message being sent. Interpreted based on the method.
Source:
Returns:
Type
String

(static) RemoteMessage#getRemoteApplicationID() → {String}

Get the field value The identifier for the sending application. This identifies the app.
Source:
Returns:
Type
String

(static) RemoteMessage#getRemotePayCompatibilityVersion() → {Number}

Get the field value This indicates the version of the SDK compatibility to the version of the Pay Display. This is set to > 1 for 'nextGen' messages
Source:
Returns:
must be an integer
Type
Number

(static) RemoteMessage#getRemoteSourceSDK() → {String}

Get the field value The identifier for the source SDK. This identifies the connector.
Source:
Returns:
Type
String

(static) RemoteMessage#getType() → {remotemessage.RemoteMessageType}

Get the field value
Source:
Returns:
Type
remotemessage.RemoteMessageType

(static) RemoteMessage#getVersion() → {Number}

Get the field value The Remote Message version.
Source:
Returns:
must be an integer
Type
Number

(static) RemoteMessage#setAttachment(attachment)

Set the field value The encoded attachment.
Parameters:
Name Type Description
attachment String
Source:

(static) RemoteMessage#setAttachmentEncoding(attachmentEncoding)

Set the field value The type of encoding used for the attachment, typically BASE64.
Parameters:
Name Type Description
attachmentEncoding String
Source:

(static) RemoteMessage#setAttachmentUri(attachmentUri)

Set the field value The attachment URI.
Parameters:
Name Type Description
attachmentUri String
Source:

(static) RemoteMessage#setFragmentIndex(fragmentIndex)

Set the field value The order of fragments when message is split for large attachments.
Parameters:
Name Type Description
fragmentIndex Number must be an integer
Source:

(static) RemoteMessage#setId(id)

Set the field value Identifier for the message
Parameters:
Name Type Description
id String
Source:

(static) RemoteMessage#setLastFragment(lastFragment)

Set the field value If this is the final fragment in a series.
Parameters:
Name Type Description
lastFragment Boolean
Source:

(static) RemoteMessage#setMethod(method)

Set the field value The name of the business message being sent
Parameters:
Name Type Description
method remotemessage.Method
Source:

(static) RemoteMessage#setPackageName(packageName)

Set the field value The package name of the sending Clover api
Parameters:
Name Type Description
packageName String
Source:

(static) RemoteMessage#setPayload(payload)

Set the field value The payload message being sent. Interpreted based on the method.
Parameters:
Name Type Description
payload String
Source:

(static) RemoteMessage#setRemoteApplicationID(remoteApplicationID)

Set the field value The identifier for the sending application. This identifies the app.
Parameters:
Name Type Description
remoteApplicationID String
Source:

(static) RemoteMessage#setRemotePayCompatibilityVersion(remotePayCompatibilityVersion)

Set the field value This indicates the version of the SDK compatibility to the version of the Pay Display. This is set to > 1 for 'nextGen' messages
Parameters:
Name Type Description
remotePayCompatibilityVersion Number must be an integer
Source:

(static) RemoteMessage#setRemoteSourceSDK(remoteSourceSDK)

Set the field value The identifier for the source SDK. This identifies the connector.
Parameters:
Name Type Description
remoteSourceSDK String
Source:

(static) RemoteMessage#setType(type)

Set the field value
Parameters:
Name Type Description
type remotemessage.RemoteMessageType
Source:

(static) RemoteMessage#setVersion(version)

Set the field value The Remote Message version.
Parameters:
Name Type Description
version Number must be an integer
Source: