Package | org.igniterealtime.xiff.data.muc |
Class | public class MUCBaseExtension |
Inheritance | MUCBaseExtension ![]() ![]() ![]() ![]() |
Implements | IExtendable, INodeProxy |
Subclasses | MUCAdminExtension, MUCOwnerExtension, MUCUserExtension |
See also
Property | Defined By | ||
---|---|---|---|
items : Array
Item interface to MUCItems if they are contained in this extension
| MUCBaseExtension | ||
![]() | xml : XML [override]
Override in order to take care of setting the Namespace and
checking for containing extensions. | Extension |
Method | Defined By | ||
---|---|---|---|
MUCBaseExtension(parent:XML = null) | MUCBaseExtension | ||
![]() |
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 | ||
![]() | 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 | |
![]() | 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 | |
![]() | 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 |
items | property |
items:Array
Item interface to MUCItems if they are contained in this extension
public function get items():Array
public function set items(value:Array):void
MUCBaseExtension | () | Constructor |
public function MUCBaseExtension(parent:XML = null)
Parameters
parent:XML (default = null )
|
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
|
MUCItem — The newly created MUCItem
|