Converse converse.js

API Documentation

Namespace: ChatBoxView

_converse.ChatBoxView

The View of an open/ongoing chat conversation.

Source:

Methods

(async, private) getHeadingButtons()

Returns a list of objects which represent buttons for the chat's header.

Source:
Fires:

(private) insertIntoTextArea(value, replaceopt, positionopt)

Insert a particular string value into the textarea of this chat box.

Parameters:
Name Type Attributes Description
value string

The value to be inserted.
replace boolean | string <optional>

Whether an existing value should be replaced. If set to true, the entire textarea will be replaced with the new value. If set to a string, then only that string will be replaced if a position is also specified.
position integer <optional>

The end index of the string to be replaced with the new value.
Source:

(private) markFollowups(el)

Given a message element, determine wether it should be marked as a followup message to the previous element.

Also determine whether the element following it is a followup message or not.

Followup messages are subsequent ones written by the same author with no other conversation elements in between and which were posted within 10 minutes of one another.

Parameters:
Name Type Description
el HTMLElement

The message element
Source:

(private) onKeyDown(ev)

Event handler for when a key is pressed down in a chat box textarea.

Parameters:
Name Type Description
ev Event
Source:

(private) onKeyUp()

Event handler for when a depressed key goes up

Source:

(private) retractOwnMessage(message)

Retract one of your messages in this chat

Parameters:
Name Type Description
message _converse.Message

The message which we're retracting.
Source: