Set some options for the chat.
- Source:
Members
(static) app_name
name of container application (e.g. owncloud or SOGo)
- Source:
(static) autoLang
auto language detection
- Source:
(static) busyTimeout
Timeout for the keepalive signal if the master is busy
- Source:
(static) chatState
Default option for chat state notifications
- Source:
(static) defaultAvatar
If no avatar is found, this function is called.
- Source:
(static) defaultLang
Default language
- Source:
(static) favicon
Options for info in favicon
- Source:
(static) fileTransfer
Options for file transfer.
- Source:
(static) hideOffline
Set to true if you want to hide offline buddies.
- Source:
(static) loginForm
If all 3 properties are set and enable is true, the login form is used
- Source:
(static) logoutElement
jquery object from logout element
- Source:
(static) mam
Options for Message Archive Management (XEP-0313)
- Source:
(static) maxStorableSize
Maximal storage size for attachments received via data channels (webrtc).
- Source:
(static) muteNotification
Mute notification sound?
- Source:
(static) notification
Should we use the HTML5 notification API?
- Source:
(static) numberOfMsg
How many messages should be logged?
- Source:
(static) onlineHelp
Link to an online user manual
- Source:
(static) otr
OTR options
- Source:
(static) popupDuration
duration for notification
- Source:
(static) priority
default xmpp priorities
- Source:
(static) root
Absolute path root of JSXC installation
- Source:
(static) rosterAppend
Place for roster
- Source:
(static) RTCPeerConfig
RTCPeerConfiguration used for audio/video calls.
- Source:
(static) screenMediaExtension :Object
Download urls to screen media extensions.
Type:
- Object
- Source:
- See:
-
- example extensions https://github.com/otalk/getScreenMedia
(static) timeout
Timeout for the keepalive signal
- Source:
(static) turnCredentialsPath
- Deprecated:
- since v2.1.0. Use now RTCPeerConfig.url.
- Source:
(static) xmpp
xmpp options
- Source:
Methods
(static) displayRosterMinimized()
This function decides wether the roster will be displayed or not if no
connection is found.
- Source:
(static) formFound()
This function is called if a login form was found, but before any
modification is done to it.
- Source:
(static) get(key)
Getter method for options. Saved options will override default one.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
string | option key |
- Source:
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:
(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:
(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:
(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: