Packageorg.igniterealtime.xiff.data.muc
Classpublic class MUCUserExtension
InheritanceMUCUserExtension Inheritance MUCBaseExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer
ImplementsIExtension

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
 Inherited_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
 InheritedXMLData : XML
[static]
XMLStanza
 InheritedXMLFactory : XMLDocument
[static]
XMLStanza
Public Methods
 MethodDefined by
  
MUCUserExtension(parent:XMLNode = null)
MUCUserExtension
 Inherited
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
 Inherited
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
XMLStanza
  
decline(to:EscapedJID, from:EscapedJID, reason:String):void
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
 Inherited
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
XMLStanza
 Inherited
exists(value:*):Boolean
[static] A helper method to determine if a value is both not null and not undefined.
XMLStanza
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(ns:String):Array
ExtensionContainer
 Inherited
getAllItems():Array
Item interface to MUCItems if they are contained in this extension
MUCBaseExtension
  
getElementName():String
MUCUserExtension
 Inherited
getExtension(name:String):Extension
ExtensionContainer
 Inherited
getNode():XMLNode
XMLStanza
  
getNS():String
MUCUserExtension
  
hasStatusCode(code:Number):Boolean
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(ns:String):void
ExtensionContainer
 Inherited
Use this method to remove all items.
MUCBaseExtension
 Inherited
ExtensionContainer
 Inherited
replaceTextNode(parent:XMLNode, original:XMLNode, elementName:String, value:String):XMLNode
Replaces one node in the stanza with another simple text node.
XMLStanza
 Inherited
serialize(parent:XMLNode):Boolean
Called when this extension is being put back on the network.
MUCBaseExtension
 Inherited
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
XMLStanza
 Inherited
toString():String
Converts the extension stanza XML to a string.
Extension
Public Constants
 ConstantDefined 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
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  [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
reasonproperty 
reason:String  [read-only]

The reason for the invite/decline/destroy

Implementation
    public function get reason():String
statusesproperty 
statuses:Array  [read-write]Implementation
    public function get statuses():Array
    public function set statuses(value:Array):void
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:XMLNode = null)

Parameters
parent:XMLNode (default = null) — (Optional) The containing XMLNode 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
deserialize()method 
public override function deserialize(node:XMLNode):BooleanParameters
node:XMLNode

Returns
Boolean
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):BooleanParameters
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"