Packageorg.igniterealtime.xiff.data.browse
Classpublic class BrowseItem
InheritanceBrowseItem Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements INodeProxy
Subclasses BrowseExtension

XEP-0011: Jabber Browsing Class that representes a child resource of a browsed resource.

OBSOLETE

See also

http://xmpp.org/extensions/xep-0011.html


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
  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
 Inheritedxml : XML
The XML node that should be used for this stanza's internal XML representation, base of the XMLStanza, XML element.
ExtensionContainer
Public Methods
 MethodDefined By
  
BrowseItem(parent:XML = null)
BrowseItem
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
  
addNamespace(value:String):XML
Add new features that are supported if you are responding to a browse request
BrowseItem
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(nameSpace:String):Array
ExtensionContainer
 Inherited
getAttribute(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML.
XMLStanza
 Inherited
getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML.
XMLStanza
 Inherited
getExtension(elementName:String):IExtension
Get the extension having the given element name.
ExtensionContainer
 Inherited
getField(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
removeAllExtensions(nameSpace:String):void
ExtensionContainer
 Inherited
removeExtension(extension:IExtension):Boolean
ExtensionContainer
 Inherited
removeFields(name:String):void
Helper method for removing all child elements that have the given name.
XMLStanza
 Inherited
setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML.
XMLStanza
 Inherited
setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML.
XMLStanza
 Inherited
setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
toString():String
Converts the base stanza XML to a string.
XMLStanza
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NS : Namespace
[static] Default XML namespace.
XMLStanza
  ELEMENT_NAME : String = item
[static]
BrowseItem
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
categoryproperty
category:String

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

The full JabberID of the entity described


Implementation
    public function get jid():String
    public function set jid(value:String):void
nameproperty 
name:String

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 ns element is allowed as a subelement of the item. This element contains a single namespace that the entity supports, and multiple ns elements can be included in any item.

For a connected client this might be >ns<jabber:iq:oob</ns>, or for a service >ns<jabber:iq:search</ns>. 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 ns 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.


Implementation
    public function get namespaces():Array
typeproperty 
type:String

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

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:XML = null)

Parameters
parent:XML (default = null)
Method Detail
addNamespace()method
public function addNamespace(value:String):XML

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

Parameters

value:String

Returns
XML
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = item