Converse converse.js

API Documentation

Module: converse-muc

Implements the non-view logic for XEP-0045 Multi-User Chat

Copyright:
  • The Converse.js contributors
License:
  • Mozilla Public License (MPLv2)
Source:

Methods

(private, inner) getDiscoInfoFeatures() → {Promise}

Use converse-disco to populate the features Model which is stored as an attibute on this _converse.ChatRoom. The results may be cached. If you want to force fetching the features from the server, call _converse.ChatRoom#refreshDiscoInfo instead.

Source:
Returns:
Type
Promise

(inner) handleDisconnection(stanza)

Handle a presence stanza that disconnects the user from the MUC

Parameters:
Name Type Description
stanza XMLElement
Source:

(private, inner) onErrorPresence(stanza)

Parses a stanza with type "error" and sets the proper connection_status value for this _converse.ChatRoom as well as any additional output that can be shown to the user.

Parameters:
Name Type Description
stanza XMLElement

The presence stanza
Source:

(private, inner) refreshDiscoInfo() → {Promise}

Refresh the disco identity, features and fields for this _converse.ChatRoom. features are stored on the features Model attribute on this _converse.ChatRoom. fields are stored on the config Model attribute on this _converse.ChatRoom.

Source:
Returns:
Type
Promise

(inner) removeNotification(actor, states)

Parameters:
Name Type Description
actor String

The nickname of the actor that caused the notification
states String | Array.<String>

The state or states representing the type of notificcation
Source:

(inner) updateNotifications(actor, state)

Update the notifications model by adding the passed in nickname to the array of nicknames that all match a particular state.

Removes the nickname from any other states it might be associated with.

The state can be a XEP-0085 Chat State or a XEP-0045 join/leave state.

Parameters:
Name Type Description
actor String

The nickname of the actor that causes the notification
state String

The state representing the type of notificcation
Source:

Type Definitions

MUCMessageData

An object containing the original groupchat message stanza, as well as the parsed attributes.

Type:
  • Object
Properties:
Name Type Description
stanza XMLElement
attrs MUCMessageAttributes
chatbox ChatRoom
Source:

OccupantData

Type:
  • Object
Properties:
Name Type Attributes Description
jid String <optional>
nick String <optional>
Source: