Packageorg.igniterealtime.xiff.data.muc
Classpublic class MUCStatus
InheritanceMUCStatus Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements INodeProxy

XEP-0306: Extensible Status Conditions for Multi-User Chat

Traditionally, Multi-User Chat [1] has used numerical status codes similar to those used in HTTP and SMTP. Numerical codes were deprecated in the core of XMPP by RFC 3920 [2] and are no longer even defined in the core schemas provided in RFC 6120 [3] (see also Error Condition Mappings [4]). In an effort to modernize the Multi-User Chat (MUC) protocol, this document defines an extensible format for status conditions in MUC.

See also

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


Public Properties
 PropertyDefined By
  code : int
Property used to add or retrieve a status code describing the condition that occurs.
MUCStatus
  message : String
Property that contains some text with a description of a condition.
MUCStatus
 Inheritedxml : XML
The XML node that should be used for this stanza's internal XML representation, base of the XMLStanza, XML element.
ExtensionContainer
Public Methods
 MethodDefined By
  
MUCStatus(parent:XML = null)
MUCStatus
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
 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
 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
 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 = status
[static]
MUCStatus
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
  NS : String = urn:xmpp:muc:conditions:1
[static] Note that this namespace is for the message element
MUCStatus
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
codeproperty
code:int

Property used to add or retrieve a status code describing the condition that occurs.


Implementation
    public function get code():int
    public function set code(value:int):void

See also

messageproperty 
message:String

Property that contains some text with a description of a condition.

One of the following values:


Implementation
    public function get message():String
    public function set message(value:String):void

See also

Constructor Detail
MUCStatus()Constructor
public function MUCStatus(parent:XML = null)

Parameters
parent:XML (default = null)
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = status

NSConstant 
public static const NS:String = urn:xmpp:muc:conditions:1

Note that this namespace is for the message element