Package | org.igniterealtime.xiff.data.muc |
Class | public class MUCExtension |
Inheritance | MUCExtension ![]() ![]() ![]() ![]() |
Implements | IMUCExtension |
See also
Property | Defined 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 | ||
![]() | xml : XML [override]
Override in order to take care of setting the Namespace and
checking for containing extensions. | Extension |
Method | Defined By | ||
---|---|---|---|
MUCExtension(parent:XML = null) | MUCExtension | ||
addChildNode(childNode:XML):void | MUCExtension | ||
![]() |
Add extension to the list of the given namespace and insert to the XML element as a child. | ExtensionContainer | |
![]() | getAllExtensions():Array | ExtensionContainer | |
![]() | getAllExtensionsByNS(nameSpace:String):Array | ExtensionContainer | |
![]() | getAttribute(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
![]() | getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML. | XMLStanza | |
![]() | getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML. | XMLStanza | |
getElementName():String | MUCExtension | ||
![]() | getExtension(elementName:String):IExtension
Get the extension having the given element name. | ExtensionContainer | |
![]() | getField(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
getNS():String | MUCExtension | ||
![]() | remove():void
Removes the extension from its parent. | Extension | |
![]() | removeAllExtensions(nameSpace:String):void | ExtensionContainer | |
![]() | removeExtension(extension:IExtension):Boolean | ExtensionContainer | |
![]() | removeFields(name:String):void
Helper method for removing all child elements that have the given name. | XMLStanza | |
![]() | setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML. | XMLStanza | |
![]() | setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML. | XMLStanza | |
![]() | setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | toString():String
Converts the base stanza XML to a string. | XMLStanza |
Constant | Defined By | ||
---|---|---|---|
![]() | DEFAULT_NS : Namespace [static]
Default XML namespace. | XMLStanza | |
ELEMENT_NAME : String = x [static] | MUCExtension | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
NS : String = http://jabber.org/protocol/muc [static] | MUCExtension | ||
![]() | STREAM_NS : Namespace [static]
| XMLStanza |
history | property |
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.
public function get history():Boolean
public function set history(value:Boolean):void
maxchars | property |
maxchars:int
Size based condition to evaluate by the server for the maximum characters to return during history retrieval
public function get maxchars():int
public function set maxchars(value:int):void
maxstanzas | property |
maxstanzas:int
Protocol based condition for the number of stanzas to return during history retrieval
public function get maxstanzas():int
public function set maxstanzas(value:int):void
password | property |
password:String
If a room is password protected, add this extension and set the password.
Use null
to remove.
public function get password():String
public function set password(value:String):void
seconds | property |
seconds:Number
Time based condition to retrive all messages for the last N seconds.
public function get seconds():Number
public function set seconds(value:Number):void
since | property |
since:String
Time base condition to retrieve all messages from a given time formatted in the format described in XEP-0082.
public function get since():String
public function set since(value:String):void
See also
MUCExtension | () | Constructor |
public function MUCExtension(parent:XML = null)
Parameters
parent:XML (default = null ) — (Optional) The containing XML for this extension
|
addChildNode | () | method |
public function addChildNode(childNode:XML):void
Parameters
childNode:XML |
getElementName | () | method |
public function getElementName():String
ReturnsString |
getNS | () | method |
public function getNS():String
ReturnsString |
ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = x
NS | Constant |
public static const NS:String = http://jabber.org/protocol/muc