class WhiteboardExtension

Object | +--org.jivesoftware.xiff.data.XMLStanza | +--org.jivesoftware.xiff.data.Extension | +--org.jivesoftware.xiff.data.whiteboard.WhiteboardExtension

Implemented Interfaces: IExtension, ISerializable

class WhiteboardExtension extends Extension

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

Author:
Sean Treadway
Since:
2.0.0

Field Summary

public static ELEMENT: String

public static NS: String

Static class variables to be overridden in subclasses;

Fields inherited from class org.jivesoftware.xiff.data.XMLStanza

XMLFactory

Property Summary

public paths: Array (read-only)

The paths available in this whiteboard message

Constructor

public WhiteboardExtension ( parent: XMLNode)

Method Summary

public deserialize ( node: XMLNode ): Boolean

Deserializes the WhiteboardExtension data.

public static enable ( ): Void

Performs the registration of this extension into the extension registry.

public getElementName ( ): String

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

public getNS ( ): String

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

public serialize ( parent: XMLNode ): Boolean

Serializes the WhiteboardExtension data to XML for sending.

Methods inherited from class org.jivesoftware.xiff.data.Extension

remove, toString

Methods inherited from class org.jivesoftware.xiff.data.XMLStanza

addTextNode, ensureNode, getNode, replaceTextNode, setNode

Field Documentation

ELEMENT

public static var ELEMENT: String

NS

public static var NS: String

Static class variables to be overridden in subclasses;

Property Documentation

paths

public paths: Array (read-only)

The paths available in this whiteboard message

Constructor Documentation

WhiteboardExtension

public function WhiteboardExtension (

parent: XMLNode)

Method Documentation

deserialize

public function deserialize (

node: XMLNode): Boolean

Deserializes the WhiteboardExtension data.

Specified by:
deserialize in interface org.jivesoftware.xiff.data.ISerializable
Parameters:
node
The XML node associated this data
Returns:
An indicator as to whether deserialization was successful

Specified by:
serialize in interface org.jivesoftware.xiff.data.ISerializable
Parameters:
parent
The parent node that this extension should be serialized into
Returns:
An indicator as to whether serialization was successful

The documentation was generated from the following file:

WhiteboardExtension.as, Last Modified: 3/10/2005 10:14:04 PM