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 128

#### <static> busyTimeout

  Timeout for the keepalive signal if the master is busy
  Source:
    - jsxc.lib.options.js, line 15

#### <static> defaultLang

  Default language
  Source:
    - jsxc.lib.options.js, line 125

#### <static> favicon

  Options for info in favicon
  Source:
    - jsxc.lib.options.js, line 217

#### <static> hideOffline

  Set to true if you want to hide offline buddies.
  Source:
    - jsxc.lib.options.js, line 151

#### <static> loginForm

  If all 3 properties are set and enable is true, the login form is used
  Source:
    - jsxc.lib.options.js, line 57

#### <static> logoutElement

  jquery object from logout element
  Source:
    - jsxc.lib.options.js, line 119

#### <static> muteNotification

  Mute notification sound?
  Source:
    - jsxc.lib.options.js, line 154

#### <static> notification

  Should we use the HTML5 notification API?
  Source:
    - jsxc.lib.options.js, line 134

#### <static> numberOfMsg

  How many messages should be logged?
  Source:
    - jsxc.lib.options.js, line 122

#### <static> onlineHelp

  Link to an online user manual
  Source:
    - jsxc.lib.options.js, line 248

#### <static> otr

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

#### <static> popupDuration

  duration for notification
  Source:
    - jsxc.lib.options.js, line 137

#### <static> priority

  default xmpp priorities
  Source:
    - jsxc.lib.options.js, line 48

#### <static> root

  Absolute path root of JSXC installation
  Source:
    - jsxc.lib.options.js, line 140

#### <static> rosterAppend

  Place for roster
  Source:
    - jsxc.lib.options.js, line 131

#### <static> RTCPeerConfig

  RTCPeerConfiguration used for audio/video calls.
  Source:
    - jsxc.lib.options.js, line 231

#### <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 228

#### <static> xmpp

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

### Methods

#### <static> defaultAvatar(jid)

  If no avatar is found, this function is called.

  ##### This:

  - {jQuery}

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `jid` |  | Jid of that user.

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

#### <static> displayRosterMinimized()

  This function decides wether the roster will be displayed or not if no connection is found.
  Source:
    - jsxc.lib.options.js, line 146

#### <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 206

  ##### 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 201

#### <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 181

#### <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 190

#### <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 222