Package | org.igniterealtime.xiff.data.muc |
Class | public class MUCBaseExtension |
Inheritance | MUCBaseExtension ![]() ![]() ![]() |
Implements | IExtendable, ISerializable |
Subclasses | MUCAdminExtension, MUCOwnerExtension, MUCUserExtension |
See also
Method | Defined by | ||
---|---|---|---|
MUCBaseExtension(parent:XMLNode = null)
| MUCBaseExtension | ||
![]() | 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 | ||
![]() |
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
| XMLStanza | |
deserialize(node:XMLNode):Boolean
| MUCBaseExtension | ||
![]() |
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 | |
getAllItems():Array
Item interface to MUCItems if they are contained in this extension
| MUCBaseExtension | ||
![]() |
getExtension(name:String):Extension
| ExtensionContainer | |
![]() |
getNode():XMLNode
| XMLStanza | |
![]() |
remove():void
Removes the extension from its parent.
| Extension | |
![]() |
removeAllExtensions(ns:String):void
| ExtensionContainer | |
removeAllItems():void
Use this method to remove all items.
| MUCBaseExtension | ||
![]() |
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
Called when this extension is being put back on the network.
| MUCBaseExtension | ||
![]() |
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 |
MUCBaseExtension | () | constructor |
public function MUCBaseExtension(parent:XMLNode = null)
Parameters
parent:XMLNode (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.
Parametersaffiliation: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
|
deserialize | () | method |
public function deserialize(node:XMLNode):Boolean
Parameters
node:XMLNode |
Boolean |
getAllItems | () | method |
public function getAllItems():Array
Item interface to MUCItems if they are contained in this extension
ReturnsArray — 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
Parametersparent:XMLNode |
Boolean |