Package | org.igniterealtime.xiff.data.muc |
Class | public class MUCUserExtension |
Inheritance | MUCUserExtension ![]() ![]() ![]() ![]() |
Implements | IExtension |
See also
Property | Defined by | ||
---|---|---|---|
![]() | _exts : Object | ExtensionContainer | |
from : EscapedJID
[read-only]
The from property for invite and decline action types
| MUCUserExtension | ||
jid : EscapedJID
[read-only]
The jid property for destroy the action type
| MUCUserExtension | ||
password : String
Property to use if the concerned room is password protected
| MUCUserExtension | ||
reason : String [read-only]
The reason for the invite/decline/destroy
| MUCUserExtension | ||
statuses : Array | MUCUserExtension | ||
to : EscapedJID
[read-only]
The to property for invite and decline action types
| MUCUserExtension | ||
type : String [read-only]
The type of user extension this is
| MUCUserExtension | ||
![]() | XMLData : XML [static]
| XMLStanza | |
![]() | XMLFactory : XMLDocument [static]
| XMLStanza |
Method | Defined by | ||
---|---|---|---|
MUCUserExtension(parent:XMLNode = null)
| MUCUserExtension | ||
![]() | 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 | |
Use this extension to decline an invitation
| MUCUserExtension | ||
deserialize(node:XMLNode):Boolean
| MUCUserExtension | ||
destroy(room:EscapedJID, reason:String):void
Use this extension to destroy a room
| MUCUserExtension | ||
![]() |
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 | |
getElementName():String
| MUCUserExtension | ||
![]() |
getExtension(name:String):Extension
| ExtensionContainer | |
![]() |
getNode():XMLNode
| XMLStanza | |
getNS():String
| MUCUserExtension | ||
hasStatusCode(code:Number):Boolean
| MUCUserExtension | ||
Use this extension to invite another user
| MUCUserExtension | ||
![]() |
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 |
Constant | Defined by | ||
---|---|---|---|
ELEMENT_NAME : String = "x" [static]
| MUCUserExtension | ||
NS : String = "http://jabber.org/protocol/muc#user" [static]
| MUCUserExtension | ||
TYPE_DECLINE : String = "decline" [static]
| MUCUserExtension | ||
TYPE_DESTROY : String = "destroy" [static]
| MUCUserExtension | ||
TYPE_INVITE : String = "invite" [static]
| MUCUserExtension | ||
TYPE_OTHER : String = "other" [static]
| MUCUserExtension |
from | property |
from:EscapedJID
[read-only]The from property for invite and decline action types
Implementation public function get from():EscapedJID
jid | property |
jid:EscapedJID
[read-only]The jid property for destroy the action type
Implementation public function get jid():EscapedJID
password | property |
password:String
[read-write]Property to use if the concerned room is password protected
Implementation public function get password():String
public function set password(value:String):void
reason | property |
reason:String
[read-only]The reason for the invite/decline/destroy
Implementation public function get reason():String
statuses | property |
statuses:Array
[read-write]Implementation
public function get statuses():Array
public function set statuses(value:Array):void
to | property |
to:EscapedJID
[read-only]The to property for invite and decline action types
Implementation public function get to():EscapedJID
type | property |
type:String
[read-only]The type of user extension this is
Implementation public function get type():String
MUCUserExtension | () | constructor |
public function MUCUserExtension(parent:XMLNode = null)
Parameters
parent:XMLNode (default = null ) — (Optional) The containing XMLNode for this extension
|
decline | () | method |
public function decline(to:EscapedJID, from:EscapedJID, reason:String):void
Use this extension to decline an invitation
Parametersto:EscapedJID |
|
from:EscapedJID |
|
reason:String |
deserialize | () | method |
public override function deserialize(node:XMLNode):Boolean
Parameters
node:XMLNode |
Boolean |
destroy | () | method |
public function destroy(room:EscapedJID, reason:String):void
Use this extension to destroy a room
Parametersroom:EscapedJID |
|
reason:String |
getElementName | () | method |
public function getElementName():String
Returns
String |
getNS | () | method |
public function getNS():String
Returns
String |
hasStatusCode | () | method |
public function hasStatusCode(code:Number):Boolean
Parameters
code:Number |
Boolean |
invite | () | method |
public function invite(to:EscapedJID, from:EscapedJID, reason:String):void
Use this extension to invite another user
Parametersto:EscapedJID |
|
from:EscapedJID |
|
reason:String |
ELEMENT_NAME | constant |
public static const ELEMENT_NAME:String = "x"
NS | constant |
public static const NS:String = "http://jabber.org/protocol/muc#user"
TYPE_DECLINE | constant |
public static const TYPE_DECLINE:String = "decline"
TYPE_DESTROY | constant |
public static const TYPE_DESTROY:String = "destroy"
TYPE_INVITE | constant |
public static const TYPE_INVITE:String = "invite"
TYPE_OTHER | constant |
public static const TYPE_OTHER:String = "other"