Packageorg.igniterealtime.xiff.data.whiteboard
Classpublic class WhiteboardExtension
InheritanceWhiteboardExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements IExtension

A message extension for whitboard exchange. This class is the base class for other extension classes such as Path. All child whiteboard objects are contained and serialized by this class

See also

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


Public Properties
 PropertyDefined By
  paths : Array
[read-only] The paths available in this whiteboard message
WhiteboardExtension
 Inheritedxml : XML
[override] Override in order to take care of setting the Namespace and checking for containing extensions.
Extension
Public Methods
 MethodDefined By
  
WhiteboardExtension(parent:XML = null)
WhiteboardExtension
 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
  
Gets the element name associated with this extension.
WhiteboardExtension
 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
Gets the namespace associated with this extension.
WhiteboardExtension
 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]
WhiteboardExtension
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
  NS : String = xiff:wb
[static]
WhiteboardExtension
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
pathsproperty
paths:Array  [read-only]

The paths available in this whiteboard message


Implementation
    public function get paths():Array
Constructor Detail
WhiteboardExtension()Constructor
public function WhiteboardExtension(parent:XML = null)

Parameters
parent:XML (default = null)
Method Detail
getElementName()method
public function getElementName():String

Gets the element name associated with this extension. The element for this extension is "x".

Returns
String — The element name
getNS()method 
public function getNS():String

Gets the namespace associated with this extension. The namespace for the WhiteboardExtension is "xiff:wb".

Returns
String — The namespace
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = x

NSConstant 
public static const NS:String = xiff:wb