ScriptX

Appearance

URLScheme ​

URL scheme utilities for script automation

URLScheme provides methods to generate URLs for opening and running scripts.

Use URLScheme to:

Note

Use args.queryParameters for accessing URL parameters

Examples ​

javascript
let runURL = URLScheme.forRunningScript();
// Returns: scriptx:///run/MyScript
javascript
let openURL = URLScheme.forOpeningScript();
// Returns: scriptx:///open/MyScript
javascript
// Use args.queryParameters instead
let params = URLScheme.allParameters();
let value = URLScheme.parameter("key");

Methods ​

allParameters ​

Get all URL parameters (deprecated)

Use args.queryParameters instead.

typescript
static allParameters(): string: string[]

Returns: Dictionary of all query parameters

Example:

javascript
URLScheme.allParameters()

parameter ​

Get a specific URL parameter (deprecated)

Use args.queryParameters[name] instead.

typescript
static parameter(name): string | null
  • name - Parameter name

Returns: Parameter value or null

Example:

javascript
URLScheme.parameter("key")

forOpeningScript ​

URL for opening the current script

Returns a URL that opens the current script in the editor.

typescript
static forOpeningScript(): string

Returns: URL string

Example:

javascript
URLScheme.forOpeningScript()

forOpeningScriptSettings ​

URL for opening script settings

Returns a URL that opens the settings for the current script.

typescript
static forOpeningScriptSettings(): string

Returns: URL string

Example:

javascript
URLScheme.forOpeningScriptSettings()

forRunningScript ​

URL for running the current script

Returns a URL that runs the current script when opened.

typescript
static forRunningScript(): string

Returns: URL string

Example:

javascript
URLScheme.forRunningScript()