|
@@ -1,6 +1,37 @@
|
|
|
-
|
|
|
-// Default configuration values
|
|
|
-// ----------------------------
|
|
|
+/**
|
|
|
+ * @typedef { Object } ConfigurationSettings
|
|
|
+ * Converse's core configuration values
|
|
|
+ * @property { Boolean } [allow_non_roster_messaging=false]
|
|
|
+ * @property { Boolean } [allow_url_history_change=true]
|
|
|
+ * @property { String } [assets_path='/dist']
|
|
|
+ * @property { ('login'|'prebind'|'anonymous'|'external' } [authentication='login']
|
|
|
+ * @property { Boolean } [auto_login=false] - Currently only used in connection with anonymous login
|
|
|
+ * @property { Boolean } [auto_reconnect=true]
|
|
|
+ * @property { Array<String>} [blacklisted_plugins]
|
|
|
+ * @property { Boolean } [clear_cache_on_logout=false]
|
|
|
+ * @property { Object } [connection_options]
|
|
|
+ * @property { String } [credentials_url] - URL from where login credentials can be fetched
|
|
|
+ * @property { Boolean } [discover_connection_methods=true]
|
|
|
+ * @property { RegExp } [geouri_regex]
|
|
|
+ * @property { RegExp } [geouri_replacement='https - //www.openstreetmap.org/?mlat=$1&mlon=$2#map=18/$1/$2']
|
|
|
+ * @property { String } [i18n]
|
|
|
+ * @property { Number } [idle_presence_timeout=300] - Seconds after which an idle presence is sent
|
|
|
+ * @property { String } [jid]
|
|
|
+ * @property { Boolean } [keepalive=true]
|
|
|
+ * @property { ('debug'|'info'|'eror') } [loglevel='info']
|
|
|
+ * @property { Array<String> } [locales]
|
|
|
+ * @property { String } [nickname]
|
|
|
+ * @property { String } [password]
|
|
|
+ * @property { ('IndexedDB'|'localStorage') } [persistent_store='IndexedDB']
|
|
|
+ * @property { String } [rid]
|
|
|
+ * @property { Element } [root=window.document]
|
|
|
+ * @property { String } [sid]
|
|
|
+ * @property { Boolean } [singleton=false]
|
|
|
+ * @property { Boolean } [strict_plugin_dependencies=false]
|
|
|
+ * @property { ('overlayed'|'fullscreen'|'mobile') } [view_mode='overlayed']
|
|
|
+ * @property { String } [websocket_url]
|
|
|
+ * @property { Array<String>} [whitelisted_plugins]
|
|
|
+ */
|
|
|
export const DEFAULT_SETTINGS = {
|
|
|
allow_non_roster_messaging: false,
|
|
|
allow_url_history_change: true,
|