Package | org.igniterealtime.xiff.data.muc |
Class | public class MUCExtension |
Inheritance | MUCExtension ![]() ![]() ![]() |
Implements | IMUCExtension |
Property | Defined by | ||
---|---|---|---|
![]() | _exts : Object | ExtensionContainer | |
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 | ||
![]() | XMLData : XML [static]
| XMLStanza | |
![]() | XMLFactory : XMLDocument [static]
| XMLStanza |
Method | Defined by | ||
---|---|---|---|
MUCExtension(parent:XMLNode = null)
| MUCExtension | ||
addChildNode(childNode:XMLNode):void
| MUCExtension | ||
![]() | ExtensionContainer | ||
![]() |
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
| XMLStanza | |
deserialize(node:XMLNode):Boolean
| MUCExtension | ||
![]() |
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
| XMLStanza | |
![]() |
exists(value:*):Boolean
[static]
A helper method to determine if a value is both not null
and not undefined.
| XMLStanza | |
![]() |
getAllExtensions():Array
| ExtensionContainer | |
![]() |
getAllExtensionsByNS(ns:String):Array
| ExtensionContainer | |
getElementName():String
| MUCExtension | ||
![]() |
getExtension(name:String):Extension
| ExtensionContainer | |
![]() |
getNode():XMLNode
| XMLStanza | |
getNS():String
| MUCExtension | ||
![]() |
remove():void
Removes the extension from its parent.
| Extension | |
![]() |
removeAllExtensions(ns:String):void
| ExtensionContainer | |
![]() |
removeExtension(ext:IExtension):Boolean
| ExtensionContainer | |
![]() |
replaceTextNode(parent:XMLNode, original:XMLNode, elementName:String, value:String):XMLNode
Replaces one node in the stanza with another simple text node.
| XMLStanza | |
serialize(parent:XMLNode):Boolean
| MUCExtension | ||
![]() |
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
| XMLStanza | |
![]() |
toString():String
Converts the extension stanza XML to a string.
| Extension |
Constant | Defined by | ||
---|---|---|---|
ELEMENT_NAME : String = "x" [static]
| MUCExtension | ||
NS : String = "http://jabber.org/protocol/muc" [static]
| MUCExtension |
history | property |
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.
Implementation public function get history():Boolean
public function set history(value:Boolean):void
maxchars | property |
maxchars:int
[read-write]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
maxstanzas | property |
maxstanzas:int
[read-write]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
password | property |
password:String
[read-write]If a room is password protected, add this extension and set the password
Implementation public function get password():String
public function set password(value:String):void
seconds | property |
seconds:Number
[read-write]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
since | property |
since:String
[read-write]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
MUCExtension | () | constructor |
public function MUCExtension(parent:XMLNode = null)
Parameters
parent:XMLNode (default = null )
|
addChildNode | () | method |
public function addChildNode(childNode:XMLNode):void
Parameters
childNode:XMLNode |
deserialize | () | method |
public function deserialize(node:XMLNode):Boolean
Parameters
node:XMLNode |
Boolean |
getElementName | () | method |
public function getElementName():String
Returns
String |
getNS | () | method |
public function getNS():String
Returns
String |
serialize | () | method |
public function serialize(parent:XMLNode):Boolean
Parameters
parent:XMLNode |
Boolean |
ELEMENT_NAME | constant |
public static const ELEMENT_NAME:String = "x"
NS | constant |
public static const NS:String = "http://jabber.org/protocol/muc"