Packageorg.igniterealtime.xiff.data.muc
Classpublic class MUCUserExtension
InheritanceMUCUserExtension Inheritance MUCBaseExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements IExtension

Implements the base MUC user protocol schema from XEP-0045 for multi-user chat.

See also

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


Public Properties
 PropertyDefined By
  from : EscapedJID
[read-only] The from property for invite and decline action types
MUCUserExtension
 Inheriteditems : 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
 Inheritedxml : XML
[override] Override in order to take care of setting the Namespace and checking for containing extensions.
Extension
Public Methods
 MethodDefined By
  
MUCUserExtension(parent:XML = null)
MUCUserExtension
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
 Inherited
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
  
decline(to:EscapedJID, from:EscapedJID, reason:String):void
Use this extension to decline an invitation
MUCUserExtension
  
destroy(room:EscapedJID, reason:String):void
Use this extension to destroy a room
MUCUserExtension
 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
  
MUCUserExtension
 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
  
getNS():String
MUCUserExtension
  
hasStatusCode(code:Number):Boolean
Does the given status code exist in the list of statuses saved in this extension.
MUCUserExtension
  
invite(to:EscapedJID, from:EscapedJID, reason:String):void
Use this extension to invite another user
MUCUserExtension
 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
  ELEMENT_NAME : String = x
[static]
MUCUserExtension
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
  NS : String = http://jabber.org/protocol/muc#user
[static]
MUCUserExtension
 InheritedSTREAM_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
Property Detail
fromproperty
from:EscapedJID  [read-only]

The from property for invite and decline action types


Implementation
    public function get from():EscapedJID
jidproperty 
jid:EscapedJID  [read-only]

The jid property for destroy the action type


Implementation
    public function get jid():EscapedJID
passwordproperty 
password:String

Property to use if the concerned room is password protected


Implementation
    public function get password():String
    public function set password(value:String):void
reasonproperty 
reason:String

The reason for the invite/decline/destroy


Implementation
    public function get reason():String
    public function set reason(value:String):void
statusesproperty 
statuses:Array

List of MUCStatus.


Implementation
    public function get statuses():Array
    public function set statuses(value:Array):void

See also

toproperty 
to:EscapedJID  [read-only]

The to property for invite and decline action types


Implementation
    public function get to():EscapedJID
typeproperty 
type:String  [read-only]

The type of user extension this is


Implementation
    public function get type():String
Constructor Detail
MUCUserExtension()Constructor
public function MUCUserExtension(parent:XML = null)

Parameters
parent:XML (default = null) — (Optional) The containing XML for this extension
Method Detail
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

Returns
String
getNS()method 
public function getNS():String

Returns
String
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

Returns
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

Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = x

NSConstant 
public static const NS:String = http://jabber.org/protocol/muc#user

TYPE_DECLINEConstant 
public static const TYPE_DECLINE:String = decline

TYPE_DESTROYConstant 
public static const TYPE_DESTROY:String = destroy

TYPE_INVITEConstant 
public static const TYPE_INVITE:String = invite

TYPE_OTHERConstant 
public static const TYPE_OTHER:String = other