Adobe CEP8 API

Class: Vulcan

Vulcan

Vulcan

The singleton instance, VulcanInterface, provides an interface
to the Vulcan. Allows you to launch CC applications
and discover information about them.

new Vulcan()

Source:

Methods

addMessageListener(type, callback, obj)

Registers a message listener callback function for a Vulcan message.

Parameters:
Name Type Description
type

The message type.
callback

The callback function that handles the message.
Takes one argument, the message object.
obj

Optional, the object containing the callback method, if any.
Default is null.
Source:

dispatchMessage(vulcanMessage)

Dispatches a Vulcan message.

Parameters:
Name Type Description
vulcanMessage

The message object.
Source:

getAppPath(targetSpecifier)

Retrieves the local install path of a CC application.

Parameters:
Name Type Description
targetSpecifier

The application specifier; for example "indesign".

   Note: In Windows 7 64-bit or Windows 8 64-bit system, some target applications (like Photoshop and Illustrator) have both 32-bit version
   and 64-bit version. Therefore, we need to specify the version by this parameter with "photoshop-70.032" or "photoshop-70.064". If you
   installed Photoshop 32-bit and 64-bit on one Windows 64-bit system and invoke this interface with parameter "photoshop-70.032", you may
   receive wrong result.
   The specifiers for Illustrator is "illustrator-17.032", "illustrator-17.064", "illustrator-17" and "illustrator".

   In other platforms there is no such issue, so we can use "photoshop" or "photoshop-70" as specifier.
Source:
Returns:

The path string if the application is found, "" otherwise.

getEndPoints()

Gets all available endpoints of the running Vulcan-enabled applications.

Since 7.0.0

Source:
Returns:

The array of all available endpoints.
An example endpoint string:


PHXS
16.1.0

getPayload(vulcanMessage)

Retrieves the message payload of a Vulcan message for the registered message listener callback function.

Parameters:
Name Type Description
vulcanMessage

The message object.
Source:
Returns:

A string containing the message payload.

getSelfEndPoint()

Gets the endpoint for itself.

Since 7.0.0

Source:
Returns:

The endpoint string for itself.

getTargetSpecifiers()

Gets all available application specifiers on the local machine.

Source:
Returns:

The array of all available application specifiers.

isAppInstalled(targetSpecifier)

Checks whether a CC application is installed on the local machine.

Parameters:
Name Type Description
targetSpecifier

The application specifier; for example "indesign".

   Note: In Windows 7 64-bit or Windows 8 64-bit system, some target applications (like Photoshop and Illustrator) have both 32-bit version
   and 64-bit version. Therefore, we need to specify the version by this parameter with "photoshop-70.032" or "photoshop-70.064". If you
   installed Photoshop 32-bit and 64-bit on one Windows 64-bit system and invoke this interface with parameter "photoshop-70.032", you may
   receive wrong result.
   The specifiers for Illustrator is "illustrator-17.032", "illustrator-17.064", "illustrator-17" and "illustrator".

   In other platforms there is no such issue, so we can use "photoshop" or "photoshop-70" as specifier.
Source:
Returns:

True if the app is installed, false otherwise.

isAppRunning(targetSpecifier)

Checks whether a CC application is running on the local machine.

Parameters:
Name Type Description
targetSpecifier

The application specifier; for example "indesign".

   Note: In Windows 7 64-bit or Windows 8 64-bit system, some target applications (like Photoshop and Illustrator) have both 32-bit version
   and 64-bit version. Therefore, we need to specify the version by this parameter with "photoshop-70.032" or "photoshop-70.064". If you
   installed Photoshop 32-bit and 64-bit on one Windows 64-bit system and invoke this interface with parameter "photoshop-70.032", you may
   receive wrong result.
   The specifiers for Illustrator is "illustrator-17.032", "illustrator-17.064", "illustrator-17" and "illustrator".

   In other platforms there is no such issue, so we can use "photoshop" or "photoshop-70" as specifier.
Source:
Returns:

True if the app is running, false otherwise.

launchApp(targetSpecifier, focus, cmdLine)

Launches a CC application on the local machine, if it is not already running.

Parameters:
Name Type Description
targetSpecifier

The application specifier; for example "indesign".

   Note: In Windows 7 64-bit or Windows 8 64-bit system, some target applications (like Photoshop and Illustrator) have both 32-bit version
   and 64-bit version. Therefore, we need to specify the version by this parameter with "photoshop-70.032" or "photoshop-70.064". If you
   installed Photoshop 32-bit and 64-bit on one Windows 64-bit system and invoke this interface with parameter "photoshop-70.032", you may
   receive wrong result.
   The specifiers for Illustrator is "illustrator-17.032", "illustrator-17.064", "illustrator-17" and "illustrator".

   In other platforms there is no such issue, so we can use "photoshop" or "photoshop-70" as specifier.
focus

True to launch in foreground, or false to launch in the background.
cmdLine

Optional, command-line parameters to supply to the launch command.
Source:
Returns:

True if the app can be launched, false otherwise.

removeMessageListener(type, callback, obj)

Removes a registered message listener callback function for a Vulcan message.

Parameters:
Name Type Description
type

The message type.
callback

The callback function that was registered.
Takes one argument, the message object.
obj

Optional, the object containing the callback method, if any.
Default is null.
Source: