Adds a new event listener for the specified event. The class will ignore duplicate registrations of the same listener to the same event.
The name of the event to add the listener for.
The listener callback to register.
This object, in support of a fluent API.
Provides the events emitted by this object as an Observable stream.
An Observable stream of all events emitted by this object.
Get the history of events for this Chat. Events consist of messages, users joining / leaving, and a variety of other events depending on the chat type.
Options that define the events the user would like to fetch.
A promise that will be resolved with an array of Chat events that match the specified search options.
Information which describes the Chat. Subclasses may provide a more specific subclass of ChatInfo.
Determines if the Chat is Joined. Chat's must be joined to perform many functions, such as sending messages.
True if the chat is joined, false otherwise.
Marks the specified event number as having been seen by the local user. It is assumed that all events prior or equal to this event have been seen by the user.
The event number to mark as set.
A promise acknowledging that seen events have been marked successfully.
Removes a single event listener for a specific event.
The name of the event to remove the listener for.
The listener callback to unregister.
This object, in support of a fluent API.
Adds a new event listener for the specified event. The class will ignore duplicate registrations of the same listener to the same event.
The name of the event to add the listener for.
The listener callback to register.
This object, in support of a fluent API.
Adds a single shot event listener for the specified event. The listener will be called the first time the specified event is fired after the event registration occurs, after which the registration will be removed and no further events will be passed to the listener.
The name of the event to add the listener for.
The listener callback to register.
This object, in support of a fluent API.
Returns the permissions manager for this chat.
the permissions manager for this chat.
Removes all listeners for all events. This is useful for cleanup before disposing of this particular event emitter.
This object, in support of a fluent API.
Removes a single event listener for a specific event.
The name of the event to remove the listener for.
The listener callback to unregister.
This object, in support of a fluent API.
Removes all listeners bound on the given event.
the name of the event to remove listeners for
This object, in support of a fluent API.
Publishes a chat message to this Chat.
The message to send.
A promise acknowledging that the message has been received by the server.
The ConvergenceSession this Chat is associated with.
Sets the short descriptive name for this chat.
The name to set.
A promise acknowledging that the name has been successfully set.
Sets the the current topic being discussed in the chat.
The topic to set.
A promise acknowledging that the topic has been successfully set.
The Chat class is the base class of all Chat types in Convergence. It provides several methods and behaviors that are common to all Chat subclasses, such as the ability to send messages, set a name and topic, etc.