Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
24
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Start documenting events with JSDoc

Browse Source
This commit is contained in:
JC Brand 2019-03-22 08:15:35 +01:00
parent 27557d6a04
commit 56bee63ed1
2 changed files with 229 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
dist/converse.js vendored
View File

@ -63284,7 +63284,7 @@ _lodash_noconflict__WEBPACK_IMPORTED_MODULE_4___default.a.templateSettings = {
const BOSH_WAIT = 59;
/**
* A private, closured object containing the private api (via `_converse.api`)
* A private, closured object containing the private api (via {@link _converse.api})
* as well as private methods and internal data-structures.
*
* @namespace _converse
@ -63562,6 +63562,29 @@ function initPlugins() {
'_converse': _converse
}, whitelist, _converse.blacklisted_plugins);
/**
* Emitted once all plugins have been initialized. This is a useful event if you want to
* register event handlers but would like your own handlers to be overridable by
* plugins. In that case, you need to first wait until all plugins have been
* initialized, so that their overrides are active. One example where this is used
* is in [converse-notifications.js](https://github.com/jcbrand/converse.js/blob/master/src/converse-notification.js)`.
*
* Also available as an [ES2015 Promise](http://es6-features.org/#PromiseUsage)
* which can be listened to with `_converse.api.waitUntil`.
*
* @event _converse#pluginsInitialized
* @memberOf _converse
*
* @example
* _converse.api.listen.on('pluginsInitialized', () => { ... });
*
* @example
* // As an ES2015 Promise
* _converse.api.waitUntil('pluginsInitialized').then(() => {
* // Your code here...
* });
*/
_converse.emit('pluginsInitialized');
}
@ -63581,6 +63604,16 @@ function initClientConfig() {
_converse.config.browserStorage = new Backbone.BrowserStorage.session(id);
_converse.config.fetch();
/**
* Emitted once the XMPP-client configuration has been initialized.
* The client configuration is independent of any particular and its values
* persist across user sessions.
*
* @event _converse#clientConfigInitialized
* @example
* _converse.api.listen.on('clientConfigInitialized', () => { ... });
*/
_converse.emit('clientConfigInitialized');
}
@ -63605,6 +63638,12 @@ _converse.initConnection = function () {
}
setUpXMLLogging();
/**
* Emitted once the `Strophe.Connection` constructor has been initialized, which
* will be responsible for managing the connection to the XMPP server.
*
* @event _converse#connectionInitialized
*/
_converse.emit('connectionInitialized');
};
@ -63912,6 +63951,16 @@ _converse.initialize = async function (settings, callback) {
_converse.tearDown();
_converse.clearSession();
/**
* Emitted after converse.js has disconnected from the XMPP server.
*
* @event _converse#disconnected
* @memberOf _converse
*
* @example
* _converse.api.listen.on('disconnected', () => { ... });
*/
_converse.emit('disconnected');
};
@ -63937,6 +63986,13 @@ _converse.initialize = async function (settings, callback) {
} else if (_converse.disconnection_cause === _converse.LOGOUT || !_lodash_noconflict__WEBPACK_IMPORTED_MODULE_4___default.a.isUndefined(reason) && reason === _lodash_noconflict__WEBPACK_IMPORTED_MODULE_4___default.a.get(strophe_js__WEBPACK_IMPORTED_MODULE_0__["Strophe"], 'ErrorCondition.NO_AUTH_MECH') || reason === "host-unknown" || reason === "remote-connection-failed" || !_converse.auto_reconnect) {
return _converse.disconnect();
}
/**
* Emitted when the connection has dropped, but Converse will attempt
* to reconnect again.
*
* @event _converse#will-reconnect
*/
_converse.emit('will-reconnect');
@ -64080,6 +64136,15 @@ _converse.initialize = async function (settings, callback) {
_converse.session.browserStorage = new Backbone.BrowserStorage.session(id);
_converse.session.fetch();
/**
* Emitted once the session has been initialized. The session is a
* persistent object which stores session information in the browser
* storage.
*
* @event _converse#sessionInitialized
* @memberOf _converse
*/
_converse.emit('sessionInitialized');
};
@ -64091,6 +64156,14 @@ _converse.initialize = async function (settings, callback) {
} else if (!_lodash_noconflict__WEBPACK_IMPORTED_MODULE_4___default.a.isUndefined(this.session) && this.session.browserStorage) {
this.session.browserStorage._clear();
}
/**
* Emitted once the session information has been cleared,
* for example when the user has logged out or when Converse has
* disconnected for some other reason.
*
* @event _converse#clearSession
*/
_converse.emit('clearSession');
};
@ -64108,6 +64181,12 @@ _converse.initialize = async function (settings, callback) {
_lodash_noconflict__WEBPACK_IMPORTED_MODULE_4___default.a.each(_lodash_noconflict__WEBPACK_IMPORTED_MODULE_4___default.a.keys(_converse.promises), addPromise);
/**
* Emitted once the user has logged out.
*
* @event _converse#logout
*/
_converse.emit('logout');
};
@ -64191,14 +64270,38 @@ _converse.initialize = async function (settings, callback) {
};
this.onStatusInitialized = function (reconnecting) {
/**
* Emitted when the user's own chat status has been initialized.
* Also available as an [ES2015 Promise](http://es6-features.org/#PromiseUsage).
*
* @event _converse#onStatusInitialized
* @example
* _converse.api.listen.on('statusInitialized', status => { ... });
* @example
* // As an ES2015 Promise
* _converse.api.waitUntil('statusInitialized').then(() => { ... });
*/
_converse.emit('statusInitialized', reconnecting);
if (reconnecting) {
_converse.emit('reconnected');
} else {
init_promise.resolve();
/**
* Emitted once converse.js has been initialized.
* See also {@link _converse#event:pluginsInitialized}.
*
* @event _converse#initialized
*/
_converse.emit('initialized');
/**
* Emitted after the connection has been established and Converse
* has got all its ducks in a row.
*
* @event _converse#initialized
*/
_converse.emit('connected');
}
@ -64236,9 +64339,7 @@ _converse.initialize = async function (settings, callback) {
},
initialize() {
this.on('change', () => {
_converse.emit('connfeedback', _converse.connfeedback);
});
this.on('change', () => _converse.emit('connfeedback', _converse.connfeedback));
}
});
@ -65136,6 +65237,19 @@ const converse = {
}
};
window.converse = converse;
/**
* Once Converse.js has loaded, it'll dispatch a custom event with the name
* `converse-loaded`.
*
* You can listen for this event in order to be informed as soon
* as converse.js has been loaded and parsed, which would mean it's safe to call
* ``converse.initialize``.
*
* @event converse-loaded
* @example
* window.addEventListener('converse-loaded', () => converse.initialize());
*/
window.dispatchEvent(new CustomEvent('converse-loaded'));
/* harmony default export */ __webpack_exports__["default"] = (converse);

116
src/headless/converse-core.js
View File

@ -62,7 +62,7 @@ _.templateSettings = {
const BOSH_WAIT = 59;
/**
* A private, closured object containing the private api (via `_converse.api`)
* A private, closured object containing the private api (via {@link _converse.api})
* as well as private methods and internal data-structures.
*
* @namespace _converse
@ -359,6 +359,28 @@ function initPlugins() {
},
'_converse': _converse
}, whitelist, _converse.blacklisted_plugins);
/**
* Emitted once all plugins have been initialized. This is a useful event if you want to
* register event handlers but would like your own handlers to be overridable by
* plugins. In that case, you need to first wait until all plugins have been
* initialized, so that their overrides are active. One example where this is used
* is in [converse-notifications.js](https://github.com/jcbrand/converse.js/blob/master/src/converse-notification.js)`.
*
* Also available as an [ES2015 Promise](http://es6-features.org/#PromiseUsage)
* which can be listened to with `_converse.api.waitUntil`.
*
* @event _converse#pluginsInitialized
* @memberOf _converse
*
* @example
* _converse.api.listen.on('pluginsInitialized', () => { ... });
*
* @example
* // As an ES2015 Promise
* _converse.api.waitUntil('pluginsInitialized').then(() => {
* // Your code here...
* });
*/
_converse.emit('pluginsInitialized');
}
@ -376,6 +398,15 @@ function initClientConfig () {
});
_converse.config.browserStorage = new Backbone.BrowserStorage.session(id);
_converse.config.fetch();
/**
* Emitted once the XMPP-client configuration has been initialized.
* The client configuration is independent of any particular and its values
* persist across user sessions.
*
* @event _converse#clientConfigInitialized
* @example
* _converse.api.listen.on('clientConfigInitialized', () => { ... });
*/
_converse.emit('clientConfigInitialized');
}
@ -398,6 +429,12 @@ _converse.initConnection = function () {
}
}
setUpXMLLogging();
/**
* Emitted once the `Strophe.Connection` constructor has been initialized, which
* will be responsible for managing the connection to the XMPP server.
*
* @event _converse#connectionInitialized
*/
_converse.emit('connectionInitialized');
}
@ -661,6 +698,15 @@ _converse.initialize = async function (settings, callback) {
_converse.connection.reset();
_converse.tearDown();
_converse.clearSession();
/**
* Emitted after converse.js has disconnected from the XMPP server.
*
* @event _converse#disconnected
* @memberOf _converse
*
* @example
* _converse.api.listen.on('disconnected', () => { ... });
*/
_converse.emit('disconnected');
};
@ -688,6 +734,12 @@ _converse.initialize = async function (settings, callback) {
!_converse.auto_reconnect) {
return _converse.disconnect();
}
/**
* Emitted when the connection has dropped, but Converse will attempt
* to reconnect again.
*
* @event _converse#will-reconnect
*/
_converse.emit('will-reconnect');
_converse.reconnect();
};
@ -810,6 +862,14 @@ _converse.initialize = async function (settings, callback) {
_converse.session = new Backbone.Model({id});
_converse.session.browserStorage = new Backbone.BrowserStorage.session(id);
_converse.session.fetch();
/**
* Emitted once the session has been initialized. The session is a
* persistent object which stores session information in the browser
* storage.
*
* @event _converse#sessionInitialized
* @memberOf _converse
*/
_converse.emit('sessionInitialized');
};
@ -820,6 +880,13 @@ _converse.initialize = async function (settings, callback) {
} else if (!_.isUndefined(this.session) && this.session.browserStorage) {
this.session.browserStorage._clear();
}
/**
* Emitted once the session information has been cleared,
* for example when the user has logged out or when Converse has
* disconnected for some other reason.
*
* @event _converse#clearSession
*/
_converse.emit('clearSession');
};
@ -833,7 +900,11 @@ _converse.initialize = async function (settings, callback) {
}
// Recreate all the promises
_.each(_.keys(_converse.promises), addPromise);
/**
* Emitted once the user has logged out.
*
* @event _converse#logout
*/
_converse.emit('logout');
};
@ -903,12 +974,35 @@ _converse.initialize = async function (settings, callback) {
};
this.onStatusInitialized = function (reconnecting) {
/**
* Emitted when the user's own chat status has been initialized.
* Also available as an [ES2015 Promise](http://es6-features.org/#PromiseUsage).
*
* @event _converse#onStatusInitialized
* @example
* _converse.api.listen.on('statusInitialized', status => { ... });
* @example
* // As an ES2015 Promise
* _converse.api.waitUntil('statusInitialized').then(() => { ... });
*/
_converse.emit('statusInitialized', reconnecting);
if (reconnecting) {
_converse.emit('reconnected');
} else {
init_promise.resolve();
/**
* Emitted once converse.js has been initialized.
* See also {@link _converse#event:pluginsInitialized}.
*
* @event _converse#initialized
*/
_converse.emit('initialized');
/**
* Emitted after the connection has been established and Converse
* has got all its ducks in a row.
*
* @event _converse#initialized
*/
_converse.emit('connected');
}
};
@ -940,9 +1034,7 @@ _converse.initialize = async function (settings, callback) {
},
initialize () {
this.on('change', () => {
_converse.emit('connfeedback', _converse.connfeedback);
});
this.on('change', () => _converse.emit('connfeedback', _converse.connfeedback));
}
});
this.connfeedback = new this.ConnectionFeedback();
@ -1798,6 +1890,20 @@ const converse = {
'utils': u
}
};
window.converse = converse;
/**
* Once Converse.js has loaded, it'll dispatch a custom event with the name
* `converse-loaded`.
*
* You can listen for this event in order to be informed as soon
* as converse.js has been loaded and parsed, which would mean it's safe to call
* ``converse.initialize``.
*
* @event converse-loaded
* @example
* window.addEventListener('converse-loaded', () => converse.initialize());
*/
window.dispatchEvent(new CustomEvent('converse-loaded'));
export default converse;