Packageorg.igniterealtime.xiff.data.muc
Classpublic class MUCBaseExtension
InheritanceMUCBaseExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer
ImplementsIExtendable, ISerializable
SubclassesMUCAdminExtension, MUCOwnerExtension, MUCUserExtension

Implements the base functionality shared by all MUC extensions

See also

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


Public Properties
 PropertyDefined by
 Inherited_exts : Object
ExtensionContainer
 InheritedXMLData : XML
[static]
XMLStanza
 InheritedXMLFactory : XMLDocument
[static]
XMLStanza
Public Methods
 MethodDefined by
  
MUCBaseExtension(parent:XMLNode = null)
MUCBaseExtension
 Inherited
ExtensionContainer
  
addItem(affiliation:String = null, role:String = null, nick:String = null, jid:EscapedJID = null, actor:String = null, reason:String = null):MUCItem
Use this method to create a new item.
MUCBaseExtension
 Inherited
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
XMLStanza
  
deserialize(node:XMLNode):Boolean
MUCBaseExtension
 Inherited
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
XMLStanza
 Inherited
exists(value:*):Boolean
[static] A helper method to determine if a value is both not null and not undefined.
XMLStanza
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(ns:String):Array
ExtensionContainer
  
getAllItems():Array
Item interface to MUCItems if they are contained in this extension
MUCBaseExtension
 Inherited
getExtension(name:String):Extension
ExtensionContainer
 Inherited
getNode():XMLNode
XMLStanza
 Inherited
remove():void
Removes the extension from its parent.
Extension
 Inherited
removeAllExtensions(ns:String):void
ExtensionContainer
  
Use this method to remove all items.
MUCBaseExtension
 Inherited
ExtensionContainer
 Inherited
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
Called when this extension is being put back on the network.
MUCBaseExtension
 Inherited
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
XMLStanza
 Inherited
toString():String
Converts the extension stanza XML to a string.
Extension
Constructor detail
MUCBaseExtension()constructor
public function MUCBaseExtension(parent:XMLNode = null)Parameters
parent:XMLNode (default = null)
Method detail
addItem()method
public function addItem(affiliation:String = null, role:String = null, nick:String = null, jid:EscapedJID = null, actor:String = null, reason:String = null):MUCItem

Use this method to create a new item. Either the affiliation or role are requried.

Parameters
affiliation:String (default = null) — A predefined string defining the affiliation the JID or nick has in relation to the room
 
role:String (default = null) — The role the jid or nick has in the room
 
nick:String (default = null) — The nickname of the new item
 
jid:EscapedJID (default = null) — The jid of the new item
 
actor:String (default = null) — The user that is actually creating the request
 
reason:String (default = null) — The reason why the action associated with this item is being preformed

Returns
MUCItem — The newly created MUCItem
deserialize()method 
public function deserialize(node:XMLNode):BooleanParameters
node:XMLNode

Returns
Boolean
getAllItems()method 
public function getAllItems():Array

Item interface to MUCItems if they are contained in this extension

Returns
Array — Array of MUCItem objects
removeAllItems()method 
public function removeAllItems():void

Use this method to remove all items.

serialize()method 
public function serialize(parent:XMLNode):Boolean

Called when this extension is being put back on the network. Perform any further serialization for Extensions and items

Parameters
parent:XMLNode

Returns
Boolean