Converse converse.js

Namespace: ChatRoomView

_converse.ChatRoomView

NativeView which renders a groupchat, based upon { @link _converse.ChatBoxView } for normal one-on-one chat boxes.

Source:

Methods

(private) afterShown()

Callback method that gets called after the chat has become visible.

Source:

(private) close()

Closes this chat box, which implies leaving the groupchat as well.

Source:

(private) closeForm()

Remove the configuration form without submitting and return to the chat view.

Source:

(private) generateHeadingTemplate()

Returns the groupchat heading TemplateResult to be rendered.

Source:

(private) getAndRenderConfigurationForm(ev)

Start the process of configuring a groupchat, either by rendering a configuration form, or by auto-configuring based on the "roomconfig" data stored on the _converse.ChatRoom. Stores the new configuration on the _converse.ChatRoom once completed.

Parameters:
Name Type Description
ev Event

DOM event that might be passed in if this method is called due to a user action. In this case, auto-configure won't happen, regardless of the settings.

Source:

(private) getHeadingButtons()

Returns a list of objects which represent buttons for the groupchat header.

Source:
Fires:

(private) getPreviousJoinOrLeaveNotification(el, nick)

Working backwards, get today's most recent join/leave notification from the same user (if any exists) after the most recent chat message.

Parameters:
Name Type Description
el HTMLElement
nick string
Source:

(private) hideOccupants()

Hide the right sidebar containing the chat occupants.

Source:

(private) hideSpinner()

Check if the spinner is being shown and if so, hide it. Also make sure then that the chat area and occupants list are both visible.

Source:

(private) renderAfterTransition()

Rerender the groupchat after some kind of transition. For example after the spinner has been removed or after a form has been submitted and removed.

Source:

(private) renderConfigurationForm(stanza:)

Renders a form given an IQ stanza containing the current groupchat configuration. Returns a promise which resolves once the user has either submitted the form, or canceled it.

Parameters:
Name Type Description
stanza: XMLElement

The IQ stanza containing the groupchat config.

Source:

(private) renderHeading(itemopt)

Renders the MUC heading if any relevant attributes have changed.

Parameters:
Name Type Attributes Description
item _converse.ChatRoom <optional>
Source:

(private) renderNicknameForm()

Renders a form which allows the user to choose theirnickname.

Source:

(private) retractOtherMessage(message, reasonopt)

Retract someone else's message in this groupchat.

Parameters:
Name Type Attributes Description
message _converse.Message

The message which we're retracting.

reason string <optional>

The reason for retracting the message.

Source:

(private) submitNickname()

Get the nickname value from the form and then join the groupchat with it.

Parameters:
Type Description
Event
Source: