Adobe CEP8 API

Class: VulcanMessage

VulcanMessage

VulcanMessage
Message type for sending messages between host applications.
A message of this type can be sent to the designated destination
when appId and appVersion are provided and valid. Otherwise,
the message is broadcast to all running Vulcan-enabled applications.

To send a message between extensions running within one
application, use the CSEvent type in CSInterface.js.

new VulcanMessage(type, appId, appVersion)

Parameters:
Name Type Description
type

The message type.
appId

The peer appId.
appVersion

The peer appVersion.
Source:

Methods

getPayload()

Retrieves the message payload of this message.

Source:
Returns:

A string containing the message payload.

initialize(message)

Initializes this message instance.

Parameters:
Name Type Description
message

A \c message instance to use for initialization.
Source:

setPayload(payload)

Sets the message payload of this message.

Parameters:
Name Type Description
payload

A string containing the message payload.
Source:

toString()

Converts the properties of this instance to a string.

Source:
Returns:

The string version of this instance.

xmlData()

Retrieves the message data.

Source:
Returns:

A data string in XML format.