Photoshop Scripting & Extension Reference

https://theiviaxx.github.io/photoshop-docs/
Admin
Comprehensive documentation combining Photoshop scripting resources, Extension SDK (CEP)...
Tokens:467,613
Snippets:8,886
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Dump Installation Info

Source: https://theiviaxx.github.io/photoshop-docs/CEP/csinterface.html

Writes installation information to a file. Returns the file path where the information was written.

```javascript
CSInterface.prototype.dumpInstallationInfo = function ()
```

--------------------------------

### dumpInstallationInfo()

Source: https://theiviaxx.github.io/photoshop-docs/CEP/csinterface.html

Writes installation information to a file.

```APIDOC
## dumpInstallationInfo()

### Description
Writes installation information to a file.

### Returns:
The file path.
```

--------------------------------

### HTML5 Video Playback Example

Source: https://theiviaxx.github.io/photoshop-docs/_sources/cep.rst.txt

An HTML5 video tag example demonstrating how to embed and play a video within your extension. Note that full-screen playback is not supported.

```html

    <video poster="http://www.html5rocks.com/en/tutorials/video/basics/star.png" controls>
        <source src="http://www.html5rocks.com/en/tutorials/video/basics/Chrome_ImF.mp4" type='video/mp4; codecs="avc1.42E01E, mp4a.40.2"'/>
    </video>

```

--------------------------------

### isQuicktimeAvailable

Source: https://theiviaxx.github.io/photoshop-docs/Photoshop/Application/isQuicktimeAvailable.html

Returns true if Quicktime is installed.

```APIDOC
## isQuicktimeAvailable

### Description
Returns true if Quicktime is installed.

### Method
() => boolean

### Returns
- **boolean**: true if Quicktime is installed, false otherwise.
```

--------------------------------

### Application.isQuicktimeAvailable

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application/isQuicktimeAvailable.rst.txt

Returns true if Quicktime is installed.

```APIDOC
## Application.isQuicktimeAvailable

### Description

Returns true if Quicktime is installed.

### Method

() - Returns a boolean value.

### Returns

- **bool**: true if Quicktime is installed, false otherwise.
```

--------------------------------

### Guides.add

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Guides/add.rst.txt

Adds a guide to the Photoshop document. Guides can be either vertical or horizontal and are positioned based on the provided coordinate.

```APIDOC
## Guides.add

### Description

Adds a guide to the Photoshop document. Guides can be either vertical or horizontal and are positioned based on the provided coordinate.

### Method

Guides.add

### Parameters

#### Path Parameters

- **direction** (Direction) - Required - Indicates whether the guide is vertical or horizontal.
- **coordinate** (UnitValue) - Required - Location of the guide from origin of image.
```

--------------------------------

### Guides.add

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Guides.rst.txt

Adds a new guide to the document. This is a static method.

```APIDOC
## Guides.add

### Description
A guide.

### Method
readonly

### Endpoint
Guides.add
```

--------------------------------

### Example: Sending Point-to-Point Vulcan Message

Source: https://theiviaxx.github.io/photoshop-docs/cep.html

Steps to send a point-to-point message: get endpoints, select a destination, create a message with destination details, and dispatch.

```javascript
var endPointList = VulcanInterface.getEndPoints();
var destIndex = 0;
var appId = GetValueByKey(endPointList[destIndex], "appId");
var appVersion = GetValueByKey(endPointList[destIndex], "appVersion");
var message = new VulcanMessage(VulcanMessage.TYPE_PREFIX + "test", appId, appVersion);
message.setPayload("blablabla...");
VulcanInterface.dispatchMessage(message);

```

--------------------------------

### Folder.encode

Source: https://theiviaxx.github.io/photoshop-docs/Core/Folder/encode.html

Encodes a string as required by RFC 2396, and returns the encoded string. All special characters are encoded in UTF-8 and stored as escaped characters starting with the percent sign followed by two hexadecimal digits. For example, the string “my file” is encoded as “my%20file”. Special characters are those with a numeric value greater than 127, except the following: / - _ . ! ~ * ‘ ( )

```APIDOC
## Folder.encode

### Description
Encodes a string as required by RFC 2396, and returns the encoded string. All special characters are encoded in UTF-8 and stored as escaped characters starting with the percent sign followed by two hexadecimal digits. For example, the string “my file” is encoded as “my%20file”. Special characters are those with a numeric value greater than 127, except the following: / - _ . ! ~ * ‘ ( )

### Method
String encode (String name)

### Parameters
#### Path Parameters
- **name** (String) - Required - The string to encode.

### See Also
encodeURI()
```

--------------------------------

### File.encode

Source: https://theiviaxx.github.io/photoshop-docs/Core/File/encode.html

Encodes a string as required by RFC 2396, and returns the encoded string. All special characters are encoded in UTF-8 and stored as escaped characters starting with the percent sign followed by two hexadecimal digits. For example, the string “my file” is encoded as “my%20file”. Special characters are those with a numeric value greater than 127, except the following: / - _ . ! ~ * ‘ ( ) See also?encodeURI().

```APIDOC
## File.encode

### Description
Encodes a string as required by RFC 2396, and returns the encoded string. All special characters are encoded in UTF-8 and stored as escaped characters starting with the percent sign followed by two hexadecimal digits. For example, the string “my file” is encoded as “my%20file”. Special characters are those with a numeric value greater than 127, except the following: / - _ . ! ~ * ‘ ( )

### Parameters
#### Path Parameters
- **name** (String) - Required - The string to encode.
```

--------------------------------

### Window Constructors

Source: https://theiviaxx.github.io/photoshop-docs/_sources/ScriptUI/Window.rst.txt

Provides information on how to create a new window instance.

```APIDOC
## Window Constructor

### Description
Creates a new window.

### Method
Constructor

### Endpoint
Window.Window()

### Parameters
None explicitly documented.

### Request Example
```javascript
var myWindow = new Window();
```

### Response
#### Success Response
- **Window** (object) - A new window object.
```

--------------------------------

### Signing Extensions with CC Extension Signing Toolkit

Source: https://theiviaxx.github.io/photoshop-docs/_sources/cep.rst.txt

Example command for signing a HTML extension using the CC Extension signing toolkit on Windows.

```bash
ccextensionswin64.exe -sign "d:\Adobe Layer Namer\Adobe Layer Namer" *(input extension path)* d:\AdobeLayerNamer.zxp *(output zxp path)* d:\\sign.p12 *(certificate path)* 1 *(certificate password)*
```

--------------------------------

### CEP Event Communication Setup

Source: https://theiviaxx.github.io/photoshop-docs/cep.html

Demonstrates setting up event listeners in a CEP extension to receive events dispatched from a native point product.

```javascript
function callback(event)
{
    // do something here
}
```

```javascript
var csInterface = new CSInterface();
csInterface.addEventListener("com.adobe.cep.test", callback);
```

--------------------------------

### TextItem.direction

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/TextItem.rst.txt

Gets the text orientation.

```APIDOC
## TextItem.direction

### Description
Gets the text orientation.

### Method
GET

### Endpoint
/TextItem/direction

### Parameters
None

### Response
#### Success Response (200)
- **direction** (string) - The text orientation.
```

--------------------------------

### name

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Gets the application name.

```APIDOC
## name

### Description
The application name.

### Method
GET

### Endpoint
/Application/name

### Response
#### Success Response (200)
- **name** (string) - The name of the application (e.g., "Adobe Photoshop").
```

--------------------------------

### CSInterface.requestOpenExtension

Source: https://theiviaxx.github.io/photoshop-docs/CEP/csinterface.html

Loads and launches another extension, or activates it if already loaded.

```APIDOC
## CSInterface.requestOpenExtension

### Description
Loads and launches another extension, or activates the extension if it is already loaded.

### Method
`requestOpenExtension(_extensionId_, _params_)`

### Parameters
#### Parameters
- **extensionId** (string) - Required - The extension’s unique identifier.
- **params** (string) - Not currently used, pass "".
```

--------------------------------

### Application.bringToFront

Source: https://theiviaxx.github.io/photoshop-docs/Photoshop/Application/bringToFront.html

Makes Photoshop the active application.

```APIDOC
## Application.bringToFront

### Description
Makes Photoshop the active application.

### Method
void

### Endpoint
N/A (Scripting method)

### Parameters
None

### Response
None
```

--------------------------------

### TextItem.font

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/TextItem.rst.txt

Gets the text face of the character.

```APIDOC
## TextItem.font

### Description
Gets the text face of the character.

### Method
GET

### Endpoint
/TextItem/font

### Parameters
None

### Response
#### Success Response (200)
- **font** (string) - The text face of the character.
```

--------------------------------

### Locale Folder Structure Example

Source: https://theiviaxx.github.io/photoshop-docs/cep.html

Illustrates the directory structure for storing localized property files within a CEP extension.

```text
YourExtension/
     |-csxs/
     |-locale/                      <-- Directory for localized resources
         |-- messages.properties    <-- The one to fallback to if no localized resources is provided for a locale
         |-- en_US/
         |        |- messages.properties
         |-- zh_CN/
                  |- messages.properties


```

--------------------------------

### path

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Gets the full path of the application.

```APIDOC
## path

### Description
The full path of the location of the Adobe Photoshop application.

### Method
GET

### Endpoint
/Application/path

### Response
#### Success Response (200)
- **path** (string) - The full file system path to the Photoshop application.
```

--------------------------------

### Create Directory using CEP File System API

Source: https://theiviaxx.github.io/photoshop-docs/_sources/cep.rst.txt

Demonstrates how to create a new directory using the `cep.fs.makedir` function. Check the `result.err` for success or failure.

```javascript
var path = "/tmp/test";
    var result = window.cep.fs.makedir(path);
    if (0 == result.err){
      ...// success
    } else {
      ...// fail
    }
```

--------------------------------

### Initialize and Use Resource Bundle

Source: https://theiviaxx.github.io/photoshop-docs/_sources/cep.rst.txt

Initializes a resource bundle to access localized strings and then writes them to the document. This is useful for displaying localized text in your extension.

```javascript
      var resourceBundle = cs.initResourceBundle();

      // Use the localized strings.
      document.write(resourceBundle.key1);
      document.write(resourceBundle.key2);
    
```

--------------------------------

### parent

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Gets the object's container.

```APIDOC
## parent

### Description
The object's container.

### Method
GET

### Endpoint
/Application/parent

### Response
#### Success Response (200)
- **parent** (object) - The parent object.
```

--------------------------------

### notifiers

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Gets the notifiers currently configured.

```APIDOC
## notifiers

### Description
The notifiers currently configured (in the Scripts Events Manager menu in the application).

### Method
GET

### Endpoint
/Application/notifiers

### Response
#### Success Response (200)
- **notifiers** (array of strings) - A list of configured notifiers.
```

--------------------------------

### Example JSON for Key Events

Source: https://theiviaxx.github.io/photoshop-docs/CEP/csinterface.html

This JSON structure demonstrates the format for specifying key events of interest to the CSInterface.

```json
[
    {
        "keyCode": 48
    },
    {
        "keyCode": 123,
        "ctrlKey": true
    },
    {
        "keyCode": 123,
        "ctrlKey": true,
        "metaKey": true
    }
]
```

--------------------------------

### measurementLog

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Gets the log of measurements taken.

```APIDOC
## measurementLog

### Description
The log of measurements taken.

### Method
GET

### Endpoint
/Application/measurementLog

### Response
#### Success Response (200)
- **log** (string) - The content of the measurement log.
```

--------------------------------

### locale

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Gets the language locale of the application.

```APIDOC
## locale

### Description
The language locale of the application.

### Method
GET

### Endpoint
/Application/locale

### Response
#### Success Response (200)
- **locale** (string) - The current language locale (e.g., "en_US").
```

--------------------------------

### CSInterface()

Source: https://theiviaxx.github.io/photoshop-docs/CEP/csinterface.html

This is the entry point to the CEP extensibility infrastructure. Instantiate this object and use it to access information about the host application, launch extensions, register for event notifications, and dispatch events.

```APIDOC
## CSInterface()

### Description
This is the entry point to the CEP extensibility infrastructure. Instantiate this object and use it to:
  * Access information about the host application in which an extension is running
  * Launch an extension
  * Register interest in event notifications, and dispatch events

### Returns
A new `CSInterface()` object.
```

--------------------------------

### Read from a File with Base64 Encoding

Source: https://theiviaxx.github.io/photoshop-docs/_sources/cep.rst.txt

This example shows how to read a file using Base64 encoding. The data read is a Base64-encoded string that needs to be decoded.

```javascript
var path = "/tmp/test";
    result = window.cep.fs.readFile(path, cep.encoding.Base64);
    if(result.err === 0){
      //success
      var base64Data = result.data;
      var data = cep.encoding.convertion.b64_to_utf8(base64Data);
    } else {
      ...// fail
    }
```

--------------------------------

### getWindowTitle

Source: https://theiviaxx.github.io/photoshop-docs/CEP/csinterface.html

Get the title of the extension window.

```APIDOC
## getWindowTitle

### Description
Get the title of the extension window.

### Method
GET (assumed)

### Endpoint
/getWindowTitle

### Parameters
None

### Response
#### Success Response (200)
- **windowTitle** (string) - The window title.
```

--------------------------------

### Set and Get Extension Window Title

Source: https://theiviaxx.github.io/photoshop-docs/cep.html

Set and get the title of extension windows. These functions work with modal and modeless extensions in all Adobe products, and panel extensions in specific Adobe applications. They utilize invokeSync to communicate with the host application.

```javascript
CSInterface.prototype.setWindowTitle = function(title){
  window.__adobe_cep__.invokeSync("setWindowTitle", title);
};

CSInterface.prototype.getWindowTitle = function(){
  return window.__adobe_cep__.invokeSync("getWindowTitle", "");
};
```

--------------------------------

### $.build

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Core/%24.rst.txt

Provides information about the ExtendScript build.

```APIDOC
## $.build

### Description

The `build` property returns information about the ExtendScript build.

### Property

`build` (readonly)

### Return Value

string - The ExtendScript build information.
```

--------------------------------

### playbackDisplayDialogs

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Gets the dialog mode for playback mode.

```APIDOC
## playbackDisplayDialogs

### Description
The dialog mode for playback mode, which indicates whether or not Photoshop displays dialogs in playback mode.

### Method
GET

### Endpoint
/Application/playbackDisplayDialogs

### Response
#### Success Response (200)
- **mode** (string) - The dialog mode (e.g., "always", "never", "dialogs").
```

--------------------------------

### Initialize Resource Bundle with CSInterface

Source: https://theiviaxx.github.io/photoshop-docs/cep.html

Initializes the locale resources using the `initResourceBundle` method of the CSInterface. This should be called when the extension loads.

```javascript
var csInterface = new CSInterface();
csInterface.initResourceBundle();


```

--------------------------------

### Configure CEF Command Line Parameters in Extension Manifest

Source: https://theiviaxx.github.io/photoshop-docs/_sources/cep.rst.txt

Use the <CEFCommandLine> and <Parameter> tags within the Extension Manifest to specify CEF command line parameters. This example shows how to enable media streaming.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ExtensionManifest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ExtensionBundleId="xx.yy.zz" ExtensionBundleVersion="1.0" Version="5.0">
    <ExtensionList>
        <Extension Id="xx.yy.zz" Version="1.0"/>
    </ExtensionList>
    <ExecutionEnvironment>
        <HostList>
            <Host Name="PHXS" Version="13.0"/>
            <Host Name="PPRO" Version="6.0"/>
        </HostList>
        <LocaleList>
            <Locale Code="All"/>
        </LocaleList>
        <RequiredRuntimeList>
            <RequiredRuntime Name="CSXS" Version="5.0"/>
        </RequiredRuntimeList>
    </ExecutionEnvironment>
    <DispatchInfoList>
        <Extension Id="xx.yy.zz">
            <DispatchInfo>
                <Resources>
                    <MainPath>./html/index.html</MainPath>
                    <CEFCommandLine>
                        <Parameter>--enable-media-stream</Parameter>
                    </CEFCommandLine>
                </Resources>
                ...
            </DispatchInfo>
        </Extension>
    </DispatchInfoList>
</ExtensionManifest>
```

--------------------------------

### ArtLayers.typename

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/ArtLayers.rst.txt

Gets the class name of the ArtLayers object.

```APIDOC
## ArtLayers.typename

### Description

Returns the string identifier for the class of the ArtLayers object.

### Method

GET

### Endpoint

/artlayers/typename

### Response

#### Success Response (200)
- **typename** (string) - The class name, which is 'ArtLayers'.
```

--------------------------------

### ArtLayers.length

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/ArtLayers.rst.txt

Gets the number of elements in the ArtLayers collection.

```APIDOC
## ArtLayers.length

### Description

Provides the total number of art layers present in the collection.

### Method

GET

### Endpoint

/artlayers/length

### Response

#### Success Response (200)
- **length** (number) - The number of art layers in the collection.
```

--------------------------------

### Window Static Methods

Source: https://theiviaxx.github.io/photoshop-docs/ScriptUI/Window.html

Provides information on static methods for interacting with ScriptUI windows, such as displaying dialogs and finding existing windows.

```APIDOC
## Window Static Methods

### alert

Displays a platform-standard dialog containing a short message and an OK button.

### confirm

Displays a platform-standard dialog containing a short message and two buttons labeled Yes and No.

### find

Use this method to find an existing window.

### prompt

Displays a modal dialog that returns the user's text input.
```

--------------------------------

### Application.refreshFonts

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application/refreshFonts.rst.txt

Forces the font list to get refreshed.

```APIDOC
## Application.refreshFonts

### Description

Force the font list to get refreshed.

### Method

void

### Endpoint

Application.refreshFonts

### Parameters

None

### Request Example

None

### Response

#### Success Response

None

#### Response Example

None
```

--------------------------------

### Property File Format Example

Source: https://theiviaxx.github.io/photoshop-docs/cep.html

Shows the key-value pair format for property files used in CEP localization. Ensure a newline after the last entry.

```properties
key1=value1
key2=value2
key3.value=value3
key4.innerHTML=value4


```

--------------------------------

### Example: Accessing Localized Strings in HTML

Source: https://theiviaxx.github.io/photoshop-docs/cep.html

Retrieves localized strings using `initResourceBundle` and displays them in HTML. Also demonstrates localizing input elements using `data-locale` attributes.

```javascript
var cs = new CSInterface();
// Get properties according to current locale of host application.
var resourceBundle = cs.initResourceBundle();
// Use the localized strings.
<script type="text/javascript">document.write(resourceBundle.key1);</script>


```

```html
<script type="text/javascript">
  var cs = new CSInterface();

  // Get properties according to current locale of host application.
  var resourceBundle = cs.initResourceBundle();

  // Use the localized strings.
  document.write(resourceBundle.key1);
  document.write(resourceBundle.key2);
</script>

<input type="submit" value="" data-locale="key3"/>
<textarea rows="10" cols="80" data-locale="key4"></textarea>


```

--------------------------------

### ScriptUIFont.family

Source: https://theiviaxx.github.io/photoshop-docs/ScriptUI/ScriptUIFont/family.html

Gets or sets the font family name.

```APIDOC
## ScriptUIFont.family

### Description
The font family name.

### Property
* **family** (String) - The font family name.
```

--------------------------------

### refreshFonts

Source: https://theiviaxx.github.io/photoshop-docs/Photoshop/Application.html

Force the font list to get refreshed.

```APIDOC
## refreshFonts

### Description
Force the font list to get refreshed.

### Method
readonly

### Endpoint
refreshFonts
```

--------------------------------

### Window.Window Constructor

Source: https://theiviaxx.github.io/photoshop-docs/ScriptUI/Window/window.html

Creates a new window with specified type, title, bounds, and properties.

```APIDOC
## Window.Window Constructor

### Description
Creates a new window.

### Method
Constructor

### Parameters
#### Path Parameters
- **type** (String) - Required - The window type.
- **title** (String) - Required - The window title, a localizable string.
- **bounds** (Bounds) - Required - The window’s position and size.
- **properties** (Object) - Required - An object containing creation-only properties.
```

--------------------------------

### Application.getCustomOptions

Source: https://theiviaxx.github.io/photoshop-docs/Photoshop/Application/getCustomOptions.html

Retrieves user objects from the Photoshop registry using a specified key.

```APIDOC
## Application.getCustomOptions

### Description
Retrieves user objects from the Photoshop registry for the ID with value key.

### Method
ActionDescriptor

### Parameters
#### Path Parameters
- **key** (String) - Required - The unique string ID for the user object.
```

--------------------------------

### isWindowVisible

Source: https://theiviaxx.github.io/photoshop-docs/CEP/csinterface.html

Get the visibility status of an extension window.

```APIDOC
## isWindowVisible

### Description
Get the visibility status of an extension window.

### Method
GET (assumed)

### Endpoint
/isWindowVisible

### Parameters
None

### Response
#### Success Response (200)
- **isVisible** (boolean) - true if the extension window is visible; false if the extension window is hidden.
```

--------------------------------

### Window.helpTip

Source: https://theiviaxx.github.io/photoshop-docs/ScriptUI/Window/helpTip.html

Gets or sets the help text that is displayed when the mouse hovers over the element.

```APIDOC
## Window.helpTip

### Description
The help text that is displayed when the mouse hovers over the element.

### Property Type
String
```

--------------------------------

### Initialize Resource Bundle

Source: https://theiviaxx.github.io/photoshop-docs/_sources/cep.rst.txt

Initializes the resource bundle for the extension with property values for the current application and UI locale. This should be called during extension loading.

```javascript
var csInterface = new CSInterface();
csInterface.initResourceBundle();
```

--------------------------------

### TextItem.firstLineIndent

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/TextItem.rst.txt

Gets the amount to indent the first line of paragraphs.

```APIDOC
## TextItem.firstLineIndent

### Description
Gets the amount to indent the first line of paragraphs. Range: -1296 to 1296.

### Method
GET

### Endpoint
/TextItem/firstLineIndent

### Parameters
None

### Response
#### Success Response (200)
- **firstLineIndent** (number) - The amount to indent the first line of paragraphs.
```

--------------------------------

### Application.typename

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Gets the class name of the object, which is 'Application' for this object.

```APIDOC
## Application.typename

### Description

Returns the class name of the object. For this object, the typename is 'Application'.

### Method

GET

### Endpoint

/Application/typename

### Response

#### Success Response (200)

- **typename** (string) - The name of the object's class, which is 'Application'.
```

--------------------------------

### Registering a Callback for Native Product Events

Source: https://theiviaxx.github.io/photoshop-docs/_sources/cep.rst.txt

Sets up a listener in a CEP extension to receive events dispatched from the native Adobe product. Requires a defined callback function.

```javascript
function callback(event)
{
    // do something here
}

var csInterface = new CSInterface();
csInterface.addEventListener("com.adobe.cep.test", callback);
```

--------------------------------

### Application.preferencesFolder

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Gets the full path to the Photoshop preferences folder.

```APIDOC
## Application.preferencesFolder

### Description

Returns the full path to the preferences folder for the Adobe Photoshop application.

### Method

GET

### Endpoint

/Application/preferencesFolder

### Response

#### Success Response (200)

- **preferencesFolder** (string) - The absolute path to the preferences folder.
```

--------------------------------

### Guides.getByName

Source: https://theiviaxx.github.io/photoshop-docs/Photoshop/Guides/getByName.html

Retrieves the first guide in the collection that matches the provided name. This is a direct method call within the Photoshop scripting environment.

```APIDOC
## Guides.getByName

### Description
Get the first element in the collection with the provided name.

### Method Signature
Guide getByName(String name)

### Parameters
#### Path Parameters
* **name** (String) - Required - The name of the guide to retrieve.
```

--------------------------------

### Application.systemInformation

Source: https://theiviaxx.github.io/photoshop-docs/_sources/Photoshop/Application.rst.txt

Fetches system information about the host application and the machine it is running on.

```APIDOC
## Application.systemInformation

### Description

Retrieves system information pertaining to the host application (Adobe Photoshop) and the machine it is running on.

### Method

GET

### Endpoint

/Application/systemInformation

### Response

#### Success Response (200)

- **systemInformation** (object) - An object containing details about the system and application.
```
Tokens:
Raw