Packageorg.igniterealtime.xiff.data.muc
Classpublic class MUCExtension
InheritanceMUCExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements IMUCExtension

Implements the base MUC protocol schema from XEP-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.

See also

http://www.xmpp.org/extensions/xep-0045.html


Public Properties
 PropertyDefined By
  history : Boolean
This is property allows a user to retrieve a server defined collection of previous messages.
MUCExtension
  maxchars : int
Size based condition to evaluate by the server for the maximum characters to return during history retrieval
MUCExtension
  maxstanzas : int
Protocol based condition for the number of stanzas to return during history retrieval
MUCExtension
  password : String
If a room is password protected, add this extension and set the password.
MUCExtension
  seconds : Number
Time based condition to retrive all messages for the last N seconds.
MUCExtension
  since : String
Time base condition to retrieve all messages from a given time formatted in the format described in XEP-0082.
MUCExtension
 Inheritedxml : XML
[override] Override in order to take care of setting the Namespace and checking for containing extensions.
Extension
Public Methods
 MethodDefined By
  
MUCExtension(parent:XML = null)
MUCExtension
  
addChildNode(childNode:XML):void
MUCExtension
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(nameSpace:String):Array
ExtensionContainer
 Inherited
getAttribute(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML.
XMLStanza
 Inherited
getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML.
XMLStanza
  
MUCExtension
 Inherited
getExtension(elementName:String):IExtension
Get the extension having the given element name.
ExtensionContainer
 Inherited
getField(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
  
getNS():String
MUCExtension
 Inherited
remove():void
Removes the extension from its parent.
Extension
 Inherited
removeAllExtensions(nameSpace:String):void
ExtensionContainer
 Inherited
removeExtension(extension:IExtension):Boolean
ExtensionContainer
 Inherited
removeFields(name:String):void
Helper method for removing all child elements that have the given name.
XMLStanza
 Inherited
setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML.
XMLStanza
 Inherited
setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML.
XMLStanza
 Inherited
setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
toString():String
Converts the base stanza XML to a string.
XMLStanza
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NS : Namespace
[static] Default XML namespace.
XMLStanza
  ELEMENT_NAME : String = x
[static]
MUCExtension
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
  NS : String = http://jabber.org/protocol/muc
[static]
MUCExtension
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
historyproperty
history:Boolean

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.


Implementation
    public function get history():Boolean
    public function set history(value:Boolean):void
maxcharsproperty 
maxchars:int

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


Implementation
    public function get maxchars():int
    public function set maxchars(value:int):void
maxstanzasproperty 
maxstanzas:int

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


Implementation
    public function get maxstanzas():int
    public function set maxstanzas(value:int):void
passwordproperty 
password:String

If a room is password protected, add this extension and set the password. Use null to remove.


Implementation
    public function get password():String
    public function set password(value:String):void
secondsproperty 
seconds:Number

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


Implementation
    public function get seconds():Number
    public function set seconds(value:Number):void
sinceproperty 
since:String

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


Implementation
    public function get since():String
    public function set since(value:String):void

See also

Constructor Detail
MUCExtension()Constructor
public function MUCExtension(parent:XML = null)

Parameters
parent:XML (default = null) — (Optional) The containing XML for this extension
Method Detail
addChildNode()method
public function addChildNode(childNode:XML):void

Parameters

childNode:XML

getElementName()method 
public function getElementName():String

Returns
String
getNS()method 
public function getNS():String

Returns
String
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = x

NSConstant 
public static const NS:String = http://jabber.org/protocol/muc