Packageorg.igniterealtime.xiff.data.browse
Classpublic class BrowseExtension
InheritanceBrowseExtension Inheritance BrowseItem Inheritance XMLStanza Inheritance ExtensionContainer
ImplementsIExtension

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
 Inherited_exts : Object
ExtensionContainer
  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
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
 InheritedXMLData : XML
[static]
XMLStanza
 InheritedXMLFactory : XMLDocument
[static]
XMLStanza
Public Methods
 MethodDefined by
  
BrowseExtension(parent:XMLNode = null)
BrowseExtension
 Inherited
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):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
ISerializable implementation which saves this extension to XML
BrowseExtension
  
enable():void
[static] Performs the registration of this extension into the extension registry.
BrowseExtension
 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
  
getElementName():String
Gets the element name associated with this extension.
BrowseExtension
 Inherited
getExtension(name:String):Extension
ExtensionContainer
 Inherited
getNode():XMLNode
XMLStanza
  
getNS():String
Gets the namespace associated with this extension.
BrowseExtension
 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
ISerializable implementation which loads this extension from XML
BrowseExtension
 Inherited
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
XMLStanza
Public Constants
 ConstantDefined by
  ELEMENT_NAME : String = "query"
[static]
BrowseExtension
  NS : String = "jabber:iq:browse"
[static]
BrowseExtension
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:XMLNode = null)Parameters
parent:XMLNode (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

deserialize()method 
public override function deserialize(node:XMLNode):Boolean

ISerializable implementation which saves this extension to XML

Parameters
node:XMLNode

Returns
Boolean

See also

enable()method 
public static function enable():void

Performs the registration of this extension into the extension registry.

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
serialize()method 
public override function serialize(parentNode:XMLNode):Boolean

ISerializable implementation which loads this extension from XML

Parameters
parentNode:XMLNode

Returns
Boolean

See also

Constant detail
ELEMENT_NAMEconstant
public static const ELEMENT_NAME:String = "query"
NSconstant 
public static const NS:String = "jabber:iq:browse"