PresenceStanza Class Reference

Object which keep data from <presence/> stanza. More...

Inheritance diagram for PresenceStanza:

[legend]Collaboration diagram for PresenceStanza:

[legend]List of all members.

Public Member Functions

• void PresenceStanza (Object node)

  Create new PresenceStanza object.
  

• String getStatus (String lang)

  Get status text for specified language.
  

• bool hasErrorElement ()

  Returns whether or not this stanza has error element.
  

• void setStatus (String status, String lang)

  Set status text for specified language.
  

Public Attributes

• int priority

  Priority of this presence stanza.
  

• String show

  Show attribute for this presence stanza.
  

• String errorType

  Type of error from this presence.
  

• String errorLang

  Language code of error from this presence.
  

• String errorText

  Text of error from this presence.
  

• int errorCode

  Error code of error from this stanza.
  

• Element userErrorCondition

  User defined condition of error from this presence.
  

• String type

  This stanza type.
  

• Object statuses

  Status text in varius languages for this presence stanza.
  

• String errorCondition

  Condition of error from this presence.
  

---

Detailed Description

Object which keep data from <presence/> stanza.

---

Constructor & Destructor Documentation

void PresenceStanza (  Object  node  )

Create new PresenceStanza object. Statuses argument can have entries in multiple languages. This can be expressed as object, which field name is language code (use empty name for default language), and value is status text in this language. If you wan't use only default language, you can pass String with proper value. Parameters: node  Object with initialization data for this stanza. Can be DOM Element <presence/>, or JavaScript Object with those fields: show - String with this presence show attribute. statuses - String or Object with message threadence status text. priority - int with presence priority. type - String with presence type. errorCode - int with error code. errorType - String with error type. errorLang - String with error language code. errorCondition - String with condition value of error. errorText - String with error text. userErrorCondition - Element with user specified error condition. See also: Stanza.Stanza for additional recognized entries.

---

Member Function Documentation

String getStatus (  String  lang  )

Get status text for specified language. If lang is not passed, status text for default language is returned. Parameters: lang  Language code of status to return. (optional) Returns: Status text for specified language. See also: subjects.

bool hasErrorElement (   )

Returns whether or not this stanza has error element. Returns: true when this stanza has error element, false otherwise.

void setStatus (  String  status, String  lang )

Set status text for specified language. status for default language is set when lang is not ommited. Parameters: status  Status text to set. lang  Language code of status to set. (optional) See also: statuses.

---

Member Data Documentation

Object statuses

Status text in varius languages for this presence stanza. See also: getStatus setStatus

---

The documentation for this class was generated from the following file:

• clientstanzas.js

---