Add roomviews.get API method
This commit is contained in:
parent
0fc5112000
commit
bfaa7e47f2
37
dist/converse.js
vendored
37
dist/converse.js
vendored
|
@ -55392,6 +55392,43 @@ _converse_headless_converse_core__WEBPACK_IMPORTED_MODULE_3__["default"].plugins
|
||||||
* @memberOf _converse.api
|
* @memberOf _converse.api
|
||||||
*/
|
*/
|
||||||
'roomviews': {
|
'roomviews': {
|
||||||
|
/**
|
||||||
|
* Retrieves a groupchat (aka chatroom) view. The chat should already be open.
|
||||||
|
*
|
||||||
|
* @method _converse.api.roomviews.get
|
||||||
|
* @param {String|string[]} name - e.g. 'coven@conference.shakespeare.lit' or
|
||||||
|
* ['coven@conference.shakespeare.lit', 'cave@conference.shakespeare.lit']
|
||||||
|
* @returns {Backbone.View} Backbone.View representing the groupchat
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // To return a single view, provide the JID of the groupchat
|
||||||
|
* const view = _converse.api.roomviews.get('coven@conference.shakespeare.lit');
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // To return an array of views, provide an array of JIDs:
|
||||||
|
* const views = _converse.api.roomviews.get(['coven@conference.shakespeare.lit', 'cave@conference.shakespeare.lit']);
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // To return views of all open groupchats, call the method without any parameters::
|
||||||
|
* const views = _converse.api.roomviews.get();
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
get(jids) {
|
||||||
|
if (_.isArray(jids)) {
|
||||||
|
const views = _converse.api.chatviews.get(jids);
|
||||||
|
|
||||||
|
return views.filter(v => v.model.get('type') === _converse.CHATROOMS_TYPE);
|
||||||
|
} else {
|
||||||
|
const view = _converse.api.chatviews.get(jids);
|
||||||
|
|
||||||
|
if (view.model.get('type') === _converse.CHATROOMS_TYPE) {
|
||||||
|
return view;
|
||||||
|
} else {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Lets you close open chatrooms.
|
* Lets you close open chatrooms.
|
||||||
*
|
*
|
||||||
|
|
|
@ -2083,6 +2083,40 @@ converse.plugins.add('converse-muc-views', {
|
||||||
* @memberOf _converse.api
|
* @memberOf _converse.api
|
||||||
*/
|
*/
|
||||||
'roomviews': {
|
'roomviews': {
|
||||||
|
/**
|
||||||
|
* Retrieves a groupchat (aka chatroom) view. The chat should already be open.
|
||||||
|
*
|
||||||
|
* @method _converse.api.roomviews.get
|
||||||
|
* @param {String|string[]} name - e.g. 'coven@conference.shakespeare.lit' or
|
||||||
|
* ['coven@conference.shakespeare.lit', 'cave@conference.shakespeare.lit']
|
||||||
|
* @returns {Backbone.View} Backbone.View representing the groupchat
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // To return a single view, provide the JID of the groupchat
|
||||||
|
* const view = _converse.api.roomviews.get('coven@conference.shakespeare.lit');
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // To return an array of views, provide an array of JIDs:
|
||||||
|
* const views = _converse.api.roomviews.get(['coven@conference.shakespeare.lit', 'cave@conference.shakespeare.lit']);
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // To return views of all open groupchats, call the method without any parameters::
|
||||||
|
* const views = _converse.api.roomviews.get();
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
get (jids) {
|
||||||
|
if (_.isArray(jids)) {
|
||||||
|
const views = _converse.api.chatviews.get(jids);
|
||||||
|
return views.filter(v => v.model.get('type') === _converse.CHATROOMS_TYPE)
|
||||||
|
} else {
|
||||||
|
const view = _converse.api.chatviews.get(jids);
|
||||||
|
if (view.model.get('type') === _converse.CHATROOMS_TYPE) {
|
||||||
|
return view;
|
||||||
|
} else {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
/**
|
/**
|
||||||
* Lets you close open chatrooms.
|
* Lets you close open chatrooms.
|
||||||
*
|
*
|
||||||
|
|
Loading…
Reference in New Issue
Block a user