org.jivesoftware.xiff.data

class Presence

Object | +--org.jivesoftware.xiff.data.XMLStanza | +--org.jivesoftware.xiff.data.XMPPStanza | +--org.jivesoftware.xiff.data.Presence

Implemented Interfaces: ISerializable

class Presence extends XMPPStanza

This class provides encapsulation for manipulation of presence data for sending and receiving.

Author:
Sean Voisen
Since:
2.0.0

Field Summary

public static AVAILABLE_TYPE: String

Static variables for specific type strings

public static ERROR_TYPE: String

public static PROBE_TYPE: String

public static SHOW_AWAY: String

Static variables for show values

public static SHOW_CHAT: String

public static SHOW_DND: String

public static SHOW_NORMAL: String

public static SHOW_XA: String

public static SUBSCRIBE_TYPE: String

public static SUBSCRIBED_TYPE: String

public static UNAVAILABLE_TYPE: String

public static UNSUBSCRIBE_TYPE: String

public static UNSUBSCRIBED_TYPE: String

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

CLIENT_NS

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

XMLFactory

Property Summary

public priority: Number (read, write)

The priority of the presence, usually on a scale of 1-5.

public show: String (read, write)

The show value; away, online, etc. There are predefined static variables in the Presence class for this:

Presence.SHOW_AWAY
Presence.SHOW_CHAT
Presence.SHOW_DND
Presence.SHOW_NORMAL
Presence.SHOW_XA

public status: String (read, write)

The status; usually used for "away messages."

Properties inherited from class org.jivesoftware.xiff.data.XMPPStanza

errorCode, errorCondition, errorMessage, errorType, from, id, to, type

Constructor

public Presence ( recipient: String, sender: String, presenceType: String, showVal: String, statusVal: String, priorityVal: Number)

Method Summary

public deserialize ( xmlNode: XMLNode ): Boolean

Deserializes an XML object and populates the Presence instance with its data.

public serialize ( parentNode: XMLNode ): Boolean

Serializes the Presence into XML form for sending to a server.

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

addExtension, deserialize, generateID, getAllExtensions, getAllExtensionsByNS, removeAllExtensions, removeExtension, serialize, setIDGenerator

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

addTextNode, ensureNode, getNode, replaceTextNode, setNode

Field Documentation

Property Documentation

priority

public priority: Number (read, write)

The priority of the presence, usually on a scale of 1-5.

show

public show: String (read, write)

The show value; away, online, etc. There are predefined static variables in the Presence class for this:

Presence.SHOW_AWAY
Presence.SHOW_CHAT
Presence.SHOW_DND
Presence.SHOW_NORMAL
Presence.SHOW_XA

status

public status: String (read, write)

The status; usually used for "away messages."

Constructor Documentation

Presence

public function Presence (

recipient: String,
sender: String,
presenceType: String,
showVal: String,
statusVal: String,
priorityVal: Number)

Method Documentation

deserialize

public function deserialize (

xmlNode: XMLNode): Boolean

Deserializes an XML object and populates the Presence instance with its data.

Specified by:
deserialize in interface ISerializable
Overrides:
XMPPStanza.deserialize in class XMPPStanza
Parameters:
xmlNode
The XML to deserialize
Returns:
An indication as to whether deserialization was sucessful

serialize

public function serialize (

parentNode: XMLNode): Boolean

Serializes the Presence into XML form for sending to a server.

Specified by:
serialize in interface ISerializable
Overrides:
XMPPStanza.serialize in class XMPPStanza
Parameters:
parentNode
(XMLNode) The container of the XML.
Returns:
An indication as to whether serialization was successful

The documentation was generated from the following file:

Presence.as, Last Modified: 3/10/2005 10:16:32 PM