DsClientSettings

DsClientSettings

new DsClientSettings()

Source:

Members

(nullable) debug_print :boolean

Source:
Type:
  • boolean

(nullable) initial_category :string

The initial value of a session's category.

Source:
Type:
  • string

(nullable) item_interpreter_options :string

Allows to control which item interpreter logic is used for attempt_bip, bip and other methods that access gui items for the current session.

Source:
Type:
  • string

(nullable) on_service_failure :function

A function that is called if the backend service generates unexpected errors.

Source:
Type:
  • function

(nullable) on_service_unavailable :function

A function that is called if the backend service cannot be reached.

Source:
Type:
  • function

(nullable) on_unauthorized_session :function

A callback to notify whenever the protocol issues an Unauthorized Session error. The error will pass to the call-specific error callback if this field is null.

Source:
Type:
  • function

(nullable) origin :string

Origin is used to track the outer client URL, the URL to the embedding page. The name is admittedly vague but it is the name used by the server side code.

Source:
Type:
  • string

session_ttl :number

Session Time To Live in seconds. Introduced to cleanup test session resources.

0 --> use server default.

Source:
Type:
  • number

(nullable) use_jsonp :boolean

Source:
Type:
  • boolean

(nullable) use_nova_protocol :boolean

Source:
Type:
  • boolean

Methods

assert_valid()

Source:

overloadWith(othernon-null) → (non-null) {spv.ds.DsClientSettings}

Creates new settings by overloading these settings with another set of settings. Null properties are left untouched, but defined properties are taken from the argument settings.

Source:
Parameters:
Name Type Description
other spv.ds.DsClientSettings
Returns:
Type:
spv.ds.DsClientSettings

toString() → (non-null) {string}

Source:
Returns:
Type:
string