org.jivesoftware.xiff.data.browse

class BrowseItem

Object | +--org.jivesoftware.xiff.data.XMLStanza | +--org.jivesoftware.xiff.data.browse.BrowseItem
Implemented Interfaces: ISerializableAll Known Subclasses: BrowseExtension

class BrowseItem extends XMLStanza
Class that representes a child resource of a browsed resource.
  • Author:
    Sean Treadway
  • Since:
    2.0.0

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

Property Summary

public category: String (read, write)
[optional] One of the categories from the list above, or a non-standard category prefixed with the string "x-".
public jid: String (read, write)
[required] The full JabberID of the entity described
public name: String (read, write)
[optional] A friendly name that may be used in a user interface
public namespaces: Array (read-only)
On top of the browsing framework, a simple form of "feature advertisement" can be built. This enables any entity to advertise which features it supports, based on the namespaces associated with those features. The element is allowed as a subelement of the item. This element contains a single namespace that the entity supports, and multiple elements can be included in any item. For a connected client this might be jabber:iq:oob, or for a service jabber:iq:search. This list of namespaces should be used to present available options for a user or to automatically locate functionality for an application. The children of a browse result may proactively contain a few elements (such as the result of the service request to the home server), which advertises the features that the particular service supports. This list may not be complete (it is only for first-pass filtering by simpler clients), and the JID should be browsed if a complete list is required.
public type: String (read, write)
[optional] -- One of the official types from the specified category, or a non-standard type prefixed with the string "x-".
public version: String (read, write)
[optional] A string containing the version of the node, equivalent to the response provided to a query in the 'jabber:iq:version' namespace. This is useful for servers, especially for lists of services (see the 'service/serverlist' category/type above).

Constructor

public BrowseItem ( parent: XMLNode)
Static class variables to be overridden in subclasses;

Method Summary

public addNamespace ( ns: String ): XMLNode
Add new features that are supported if you are responding to a browse request
public deserialize ( node: XMLNode ): Boolean
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
public serialize ( parentNode: XMLNode ): Boolean
Called when the library need to retrieve the state of the instance. If the instance manages its own state, then the state should be copied into the XMLNode passed. If the instance also implements INodeProxy, then the parent should be verified against the parent XMLNode passed to determine if the serialization is in the same namespace.
Methods inherited from class org.jivesoftware.xiff.data.XMLStanza

Property Documentation


Constructor Documentation


Method Documentation


The documentation was generated from the following file: