Packageorg.igniterealtime.xiff.data.browse
Classpublic class BrowseExtension
InheritanceBrowseExtension Inheritance BrowseItem Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements IExtension

XEP-0011: Jabber Browsing

Implements jabber:iq:browse namespace. Use this extension to request the items of an agent or service such as the rooms of a conference server or the members of a room.

OBSOLETE

See also

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


Public Properties
 PropertyDefined By
 Inheritedcategory : String
One of the categories from the list above, or a non-standard category prefixed with the string "x-".
BrowseItem
  items : Array
[read-only] An array of BrowseItems containing information about the browsed resource
BrowseExtension
 Inheritedjid : String
The full JabberID of the entity described
BrowseItem
 Inheritedname : String
A friendly name that may be used in a user interface
BrowseItem
 Inheritednamespaces : Array
[read-only] On top of the browsing framework, a simple form of "feature advertisement" can be built.
BrowseItem
 Inheritedtype : String
One of the official types from the specified category, or a non-standard type prefixed with the string "x-".
BrowseItem
 Inheritedversion : 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
  
BrowseExtension(parent:XML = null)
BrowseExtension
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
  
If you are generating a browse response to a browse request, then fill out the items list with this method.
BrowseExtension
 Inherited
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
  
Gets the element name associated with this extension.
BrowseExtension
 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
  
getNS():String
Gets the namespace associated with this extension.
BrowseExtension
 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 = query
[static]
BrowseExtension
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
  NS : String = jabber:iq:browse
[static]
BrowseExtension
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
itemsproperty
items:Array  [read-only]

An array of BrowseItems containing information about the browsed resource


Implementation
    public function get items():Array

See also

Constructor Detail
BrowseExtension()Constructor
public function BrowseExtension(parent:XML = null)

Parameters
parent:XML (default = null)
Method Detail
addItem()method
public function addItem(item:BrowseItem):BrowseItem

If you are generating a browse response to a browse request, then fill out the items list with this method.

Parameters

item:BrowseItem — BrowseItem which contains the info related to the browsed resource

Returns
BrowseItem — the item added

See also

getElementName()method 
public function getElementName():String

Gets the element name associated with this extension. The element for this extension is "query".

Returns
String
getNS()method 
public function getNS():String

Gets the namespace associated with this extension. The namespace for the BrowseExtension is "jabber:iq:browse".

Returns
String — The namespace
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = query

NSConstant 
public static const NS:String = jabber:iq:browse