Packageorg.igniterealtime.xiff.data.muc
Classpublic class MUCBaseExtension
InheritanceMUCBaseExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements IExtendable, INodeProxy
Subclasses MUCAdminExtension, MUCOwnerExtension, MUCUserExtension

Implements the base functionality shared by all MUC extensions

See also

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


Public Properties
 PropertyDefined By
  items : Array
Item interface to MUCItems if they are contained in this extension
MUCBaseExtension
 Inheritedxml : XML
[override] Override in order to take care of setting the Namespace and checking for containing extensions.
Extension
Public Methods
 MethodDefined By
  
MUCBaseExtension(parent:XML = null)
MUCBaseExtension
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
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
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
 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
 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
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
itemsproperty
items:Array

Item interface to MUCItems if they are contained in this extension


Implementation
    public function get items():Array
    public function set items(value:Array):void
Constructor Detail
MUCBaseExtension()Constructor
public function MUCBaseExtension(parent:XML = null)

Parameters
parent:XML (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