ServerSetting

Server specific runtime settings.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, File, Number, Object, String

Hierarchy:

Superclass: Preference

Class: ServerSetting

Property Listing

Property

Type

Access

Description

adminPort

Number

readonly

The socket the server uses to service administrative requests.

configuration

String

readonly

The configuration name for this instance of the server.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

heartbeatUpdateInterval

Number

readonly

The time interval (in seconds) at which last active timestamp of IDS is updated to IDS console app.

hostName

String

readonly

The name of the machine InDesignServer is running on; either symbolic (host.corp.com) or IP address (123.345.678.90).

imagePreview

Boolean

read/write

If true, generates image previews.

iorFile

File

readonly

Location to write the IOR file for CORBA.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

javascriptUi

Boolean

read/write

If true, makes the native JavaScript user interface available.

maximumErrors

Number

read/write

Maximum number of errors to save.

nonBlockingSessionSupport

Boolean

read/write

If true, BeginSession requests are not blocked if no new session can be started currently (for cases when server is busy).

onMainThreadOnly

Boolean

readonly

If true, client requests are executed on main thread only.

parent

Application

readonly

The parent of the ServerSetting (a Application).

pluginPaths

Array of File

readonly

Additional paths from which to load plugins.

port

Number

readonly

The socket the server uses to service SOAP requests.

properties

Object

read/write

A property that allows setting of several properties at the same time.

sendCrashLogs

Boolean

readonly

If true, send crash log data to Adobe.

sessionSupportLoggingEnabled

Boolean

readonly

If true, session support logging is enabled.

sessionSupportMaxWait

Number

read/write

The maximum time (in seconds) for which client wants to wait for BeginSession request to be serviced.

sessionTimeout

Number

readonly

The session timeout (in seconds) for soap sessions.

useConsole

Boolean

readonly

If true, output is going to a console window.

useErrorList

Boolean

read/write

If true, errors are saved in the error list.

useEventLog

Boolean

readonly

If true, output is redirected to the system event log.

useStructuredEventHandler

Boolean

readonly

If true, install structured event handler.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

ServerSetting getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the ServerSetting.

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.serverSettings

Event.parent

EventListener.parent

MutationEvent.parent

Return

ServerSetting.getElements()