Main Page Packages Class Tree Index Help

Previous | Next

Frames | No Frames

Summary: Field | Property | Contructor | Method

Detail: Field | Property | Contructor | Method

org.jivesoftware.xiff.data.muc

class MUCOwnerExtension

Object | +--org.jivesoftware.xiff.data.XMLStanza | +--org.jivesoftware.xiff.data.Extension | +--org.jivesoftware.xiff.data.muc.MUCBaseExtension | +--org.jivesoftware.xiff.data.muc.MUCOwnerExtension

Implemented Interfaces: IExtension

class MUCOwnerExtension extends MUCBaseExtension

Implements the administration command data model in JEP-0045 for multi-user chat.

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

Constructor

public MUCOwnerExtension ( parent: XMLNode)

Method Summary

public deserialize ( node: XMLNode ): Boolean

Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.

public destroy ( reason: String, alternateJID: String ): Void

Replaces the destroy node with a new node and sets the reason element and jid attribute

public getElementName ( ): String

public getNS ( ): String

public serialize ( parent: XMLNode ): Boolean

Called when this extension is being put back on the network. Perform any further serialization for Extensions and items

Methods inherited from class org.jivesoftware.xiff.data.muc.MUCBaseExtension

addExtension, addItem, deserialize, getAllExtensions, getAllExtensionsByNS, getAllItems, MUCBaseExtensionStatic, removeAllExtensions, removeAllItems, removeExtension, serialize

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;

Constructor Documentation

MUCOwnerExtension

public function MUCOwnerExtension (

parent: XMLNode)

Method Documentation

deserialize

public function deserialize (

node: XMLNode): Boolean

Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.

Overrides:
MUCBaseExtension.deserialize in class MUCBaseExtension
Parameters:
node
(XMLNode) The node that should be used as the data container.

destroy

public function destroy (

reason: String,
alternateJID: String): Void

Replaces the destroy node with a new node and sets the reason element and jid attribute

Parameters:
reason
A string describing the reason for room destruction
alternateJID
A string containing a JID that room members can use instead of this room

getElementName

public function getElementName (

Specified by:
getElementName in interface org.jivesoftware.xiff.data.IExtension

getNS

public function getNS (

Specified by:
getNS in interface org.jivesoftware.xiff.data.IExtension

serialize

public function serialize (

parent: XMLNode): Boolean

Called when this extension is being put back on the network. Perform any further serialization for Extensions and items

Overrides:
MUCBaseExtension.serialize in class MUCBaseExtension
Parameters:
parent
parentNode (XMLNode) The container of the XML.

The documentation was generated from the following file:

MUCOwnerExtension.as, Last Modified: 3/10/2005 10:12:44 PM