Packageorg.igniterealtime.xiff.data.browse
Classpublic class BrowseItem
InheritanceBrowseItem Inheritance XMLStanza Inheritance ExtensionContainer
ImplementsISerializable
SubclassesBrowseExtension

Class that representes a child resource of a browsed resource.



Public Properties
 PropertyDefined by
  category : String
One of the categories from the list above, or a non-standard category prefixed with the string "x-".
BrowseItem
 Inherited_exts : Object
ExtensionContainer
  jid : String
The full JabberID of the entity described
BrowseItem
  name : String
A friendly name that may be used in a user interface
BrowseItem
  namespaces : Array
[read-only] On top of the browsing framework, a simple form of "feature advertisement" can be built.
BrowseItem
  type : String
One of the official types from the specified category, or a non-standard type prefixed with the string "x-".
BrowseItem
  version : String
A string containing the version of the node, equivalent to the response provided to a query in the 'jabber:iq:version' namespace.
BrowseItem
 InheritedXMLData : XML
[static]
XMLStanza
 InheritedXMLFactory : XMLDocument
[static]
XMLStanza
Public Methods
 MethodDefined by
  
BrowseItem(parent:XMLNode)
BrowseItem
 Inherited
ExtensionContainer
  
addNamespace(value:String):XMLNode
Add new features that are supported if you are responding to a browse request
BrowseItem
 Inherited
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
XMLStanza
  
deserialize(node:XMLNode):Boolean
BrowseItem
 Inherited
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
XMLStanza
 Inherited
exists(value:*):Boolean
[static] A helper method to determine if a value is both not null and not undefined.
XMLStanza
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(ns:String):Array
ExtensionContainer
 Inherited
getExtension(name:String):Extension
ExtensionContainer
 Inherited
getNode():XMLNode
XMLStanza
 Inherited
removeAllExtensions(ns:String):void
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
replaceTextNode(parent:XMLNode, original:XMLNode, elementName:String, value:String):XMLNode
Replaces one node in the stanza with another simple text node.
XMLStanza
  
serialize(parentNode:XMLNode):Boolean
BrowseItem
 Inherited
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
XMLStanza
Property detail
categoryproperty
category:String  [read-write]

One of the categories from the list above, or a non-standard category prefixed with the string "x-".

Implementation
    public function get category():String
    public function set category(value:String):void

See also

jidproperty 
jid:String  [read-write]

The full JabberID of the entity described

Implementation
    public function get jid():String
    public function set jid(value:String):void
nameproperty 
name:String  [read-write]

A friendly name that may be used in a user interface

Implementation
    public function get name():String
    public function set name(value:String):void
namespacesproperty 
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 whichfeatures 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 connectedclient this might be jabber:iq:oob, or for a servicejabber: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. Thislist 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.

Implementation
    public function get namespaces():Array
typeproperty 
type:String  [read-write]

One of the official types from the specified category, or a non-standard type prefixed with the string "x-".

Implementation
    public function get type():String
    public function set type(value:String):void

See also

versionproperty 
version:String  [read-write]

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).

Implementation
    public function get version():String
    public function set version(value:String):void
Constructor detail
BrowseItem()constructor
public function BrowseItem(parent:XMLNode)Parameters
parent:XMLNode
Method detail
addNamespace()method
public function addNamespace(value:String):XMLNode

Add new features that are supported if you are responding to a browse request

Parameters
value:String

Returns
XMLNode
deserialize()method 
public function deserialize(node:XMLNode):BooleanParameters
node:XMLNode

Returns
Boolean
serialize()method 
public function serialize(parentNode:XMLNode):BooleanParameters
parentNode:XMLNode

Returns
Boolean