org.jivesoftware.xiff.data.muc

class MUCExtension

Object | +--org.jivesoftware.xiff.data.XMLStanza | +--org.jivesoftware.xiff.data.Extension | +--org.jivesoftware.xiff.data.muc.MUCExtension

Implemented Interfaces: IExtension, ISerializable

class MUCExtension extends Extension

Implements the base MUC protocol schema from JEP-0045 for multi-user chat. This extension is typically used to test for the presence of MUC enabled conferencing service, or a MUC related error condition.

Author:
Sean Treadway
Since:
2.0.0

Field Summary

public static ELEMENT: String

public static NS: String

Static class variables to be overridden in subclasses;

Fields inherited from class org.jivesoftware.xiff.data.XMLStanza

XMLFactory

Property Summary

public history: Boolean (read, write)

This is property allows a user to retrieve a server defined collection of previous messages. Set this property to "true" to retrieve a history of the dicussions.

public maxchars: Number (read, write)

Size based condition to evaluate by the server for the maximum characters to return during history retrieval

public maxstanzas: Number (read, write)

Protocol based condition for the number of stanzas to return during history retrieval

public password: String (read, write)

If a room is password protected, add this extension and set the password

public seconds: Number (read, write)

Time based condition to retrive all messages for the last N seconds.

public since: String (read, write)

Time base condition to retrieve all messages from a given time formatted in the format described in JEP-0082.

Constructor

public MUCExtension ( parent: XMLNode)

Method Summary

public deserialize ( node: XMLNode ): Boolean

Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.

public getElementName ( ): String

public getNS ( ): String

public serialize ( parent: XMLNode ): Boolean

Called when the library need to retrieve the state of the instance. If the instance manages its own state, then the state should be copied into the XMLNode passed. If the instance also implements INodeProxy, then the parent should be verified against the parent XMLNode passed to determine if the serialization is in the same namespace.

Methods inherited from class org.jivesoftware.xiff.data.Extension

remove, toString

Methods inherited from class org.jivesoftware.xiff.data.XMLStanza

addTextNode, ensureNode, getNode, replaceTextNode, setNode