Package | org.igniterealtime.xiff.data.muc |
Class | public class MUCUserExtension |
Inheritance | MUCUserExtension ![]() ![]() ![]() ![]() ![]() |
Implements | IExtension |
See also
Property | Defined By | ||
---|---|---|---|
from : EscapedJID [read-only]
The from property for invite and decline action types
| MUCUserExtension | ||
![]() | items : Array
Item interface to MUCItems if they are contained in this extension
| MUCBaseExtension | |
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
The reason for the invite/decline/destroy
| MUCUserExtension | ||
statuses : Array
List of MUCStatus. | 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 | ||
![]() | xml : XML [override]
Override in order to take care of setting the Namespace and
checking for containing extensions. | Extension |
Method | Defined By | ||
---|---|---|---|
MUCUserExtension(parent:XML = null) | MUCUserExtension | ||
![]() |
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 | |
Use this extension to decline an invitation
| MUCUserExtension | ||
destroy(room:EscapedJID, reason:String):void
Use this extension to destroy a room
| MUCUserExtension | ||
![]() | 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 | |
getElementName():String | MUCUserExtension | ||
![]() | 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 | |
getNS():String | MUCUserExtension | ||
hasStatusCode(code:Number):Boolean
Does the given status code exist in the list of statuses saved in this extension. | MUCUserExtension | ||
Use this extension to invite another user
| MUCUserExtension | ||
![]() | 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 |
Constant | Defined By | ||
---|---|---|---|
![]() | DEFAULT_NS : Namespace [static]
Default XML namespace. | XMLStanza | |
ELEMENT_NAME : String = x [static] | MUCUserExtension | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
NS : String = http://jabber.org/protocol/muc#user [static] | MUCUserExtension | ||
![]() | STREAM_NS : Namespace [static]
| XMLStanza | |
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
public function get from():EscapedJID
jid | property |
jid:EscapedJID
[read-only] The jid property for destroy the action type
public function get jid():EscapedJID
password | property |
password:String
Property to use if the concerned room is password protected
public function get password():String
public function set password(value:String):void
reason | property |
reason:String
The reason for the invite/decline/destroy
public function get reason():String
public function set reason(value:String):void
statuses | property |
statuses:Array
List of MUCStatus.
public function get statuses():Array
public function set statuses(value:Array):void
See also
to | property |
to:EscapedJID
[read-only] The to property for invite and decline action types
public function get to():EscapedJID
type | property |
type:String
[read-only] The type of user extension this is
public function get type():String
MUCUserExtension | () | Constructor |
public function MUCUserExtension(parent:XML = null)
Parameters
parent:XML (default = null ) — (Optional) The containing XML for this extension
|
decline | () | method |
public function decline(to:EscapedJID, from:EscapedJID, reason:String):void
Use this extension to decline an invitation
Parameters
to:EscapedJID | |
from:EscapedJID | |
reason:String |
destroy | () | method |
public function destroy(room:EscapedJID, reason:String):void
Use this extension to destroy a room
Parameters
room:EscapedJID | |
reason:String |
getElementName | () | method |
public function getElementName():String
ReturnsString |
getNS | () | method |
public function getNS():String
ReturnsString |
hasStatusCode | () | method |
public function hasStatusCode(code:Number):Boolean
Does the given status code exist in the list of statuses saved in this extension.
Parameters
code:Number |
Boolean — |
invite | () | method |
public function invite(to:EscapedJID, from:EscapedJID, reason:String):void
Use this extension to invite another user
Parameters
to: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