JSDoc: Namespace: options

# Namespace: options

## jsxc.options

Set some options for the chat.

Source:
  - jsxc.lib.options.js, line 1

### Members

#### (static) app_name

name of container application (e.g. owncloud or SOGo)

Source:
  - jsxc.lib.options.js, line 9

#### (static) autoLang

auto language detection

Source:
  - jsxc.lib.options.js, line 143

#### (static) busyTimeout

Timeout for the keepalive signal if the master is busy

Source:
  - jsxc.lib.options.js, line 15

#### (static) chatState

Default option for chat state notifications

Source:
  - jsxc.lib.options.js, line 291

#### (static) defaultAvatar

If no avatar is found, this function is called.

Source:
  - jsxc.lib.options.js, line 177

#### (static) defaultLang

Default language

Source:
  - jsxc.lib.options.js, line 140

#### (static) favicon

Options for info in favicon

Source:
  - jsxc.lib.options.js, line 230

#### (static) fileTransfer

Options for file transfer.

Source:
  - jsxc.lib.options.js, line 283

#### (static) hideOffline

Set to true if you want to hide offline buddies.

Source:
  - jsxc.lib.options.js, line 166

#### (static) loginForm

If all 3 properties are set and enable is true, the login form is used

Source:
  - jsxc.lib.options.js, line 72

#### (static) logoutElement

jquery object from logout element

Source:
  - jsxc.lib.options.js, line 134

#### (static) mam

Options for Message Archive Management (XEP-0313)

Source:
  - jsxc.lib.options.js, line 309

#### (static) maxStorableSize

Maximal storage size for attachments received via data channels (webrtc).

Source:
  - jsxc.lib.options.js, line 280

#### (static) muteNotification

Mute notification sound?

Source:
  - jsxc.lib.options.js, line 169

#### (static) notification

Should we use the HTML5 notification API?

Source:
  - jsxc.lib.options.js, line 149

#### (static) numberOfMsg

How many messages should be logged?

Source:
  - jsxc.lib.options.js, line 137

#### (static) onlineHelp

Link to an online user manual

Source:
  - jsxc.lib.options.js, line 261

#### (static) otr

OTR options

Source:
  - jsxc.lib.options.js, line 18

#### (static) popupDuration

duration for notification

Source:
  - jsxc.lib.options.js, line 152

#### (static) priority

default xmpp priorities

Source:
  - jsxc.lib.options.js, line 54

#### (static) root

Absolute path root of JSXC installation

Source:
  - jsxc.lib.options.js, line 155

#### (static) rosterAppend

Place for roster

Source:
  - jsxc.lib.options.js, line 146

#### (static) RTCPeerConfig

RTCPeerConfiguration used for audio/video calls.

Source:
  - jsxc.lib.options.js, line 244

#### (static) screenMediaExtension :Object

Download urls to screen media extensions.

##### Type:

- Object

Source:
  - jsxc.lib.options.js, line 301
See:
  - example extensions https://github.com/otalk/getScreenMedia

#### (static) timeout

Timeout for the keepalive signal

Source:
  - jsxc.lib.options.js, line 12

#### (static) turnCredentialsPath

Deprecated:
  - since v2.1.0. Use now RTCPeerConfig.url.
Source:
  - jsxc.lib.options.js, line 241

#### (static) xmpp

xmpp options

Source:
  - jsxc.lib.options.js, line 27

### Methods

#### (static) displayRosterMinimized()

This function decides wether the roster will be displayed or not if no connection is found.

Source:
  - jsxc.lib.options.js, line 161

#### (static) formFound()

This function is called if a login form was found, but before any modification is done to it.

Source:
  - jsxc.lib.options.js, line 69

#### (static) get(key)

Getter method for options. Saved options will override default one.

##### Parameters:

Name | Type | Description
--- | --- | ---
`key` | string | option key

Source:
  - jsxc.lib.js, line 237

##### Returns:

default or saved option value

#### (static) getUsers(search, cb)

Returns a list of usernames and aliases

##### Parameters:

Name | Type | Description
--- | --- | ---
`search` | string | Search token (start with)
`cb` | getUsers-cb | Called with list of users

Source:
  - jsxc.lib.options.js, line 219

#### (static) loadSettings(username, password, cb)

Returns permanent saved settings and overwrite default jsxc.options.

##### Parameters:

Name | Type | Description
--- | --- | ---
`username` | string | username
`password` | string | password
`cb` | loadSettingsCallback | Callback that handles the result

Source:
  - jsxc.lib.options.js, line 194

#### (static) saveSettinsPermanent(data, cb)

Call this function to save user settings permanent.

##### Parameters:

Name | Type | Description
--- | --- | ---
`data` |  | Holds all data as key/value
`cb` |  | Called with true on success, false otherwise

Source:
  - jsxc.lib.options.js, line 203

#### (static) set(key, value)

Setter method for options. Will write into localstorage.

##### Parameters:

Name | Type | Description
--- | --- | ---
`key` | string | option key
`value` | object | option value

Source:
  - jsxc.lib.js, line 253