Package | org.igniterealtime.xiff.data.browse |
Class | public class BrowseExtension |
Inheritance | BrowseExtension ![]() ![]() ![]() ![]() |
Implements | IExtension |
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
Property | Defined By | ||
---|---|---|---|
![]() | category : 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 | ||
![]() | 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 | |
![]() | xml : XML
The XML node that should be used for this stanza's internal XML representation,
base of the XMLStanza, XML element. | ExtensionContainer |
Method | Defined By | ||
---|---|---|---|
BrowseExtension(parent:XML = null) | BrowseExtension | ||
![]() |
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 | ||
![]() | addNamespace(value:String):XML
Add new features that are supported if you are responding to a
browse request
| BrowseItem | |
![]() | getAllExtensions():Array | ExtensionContainer | |
![]() | getAllExtensionsByNS(nameSpace:String):Array | ExtensionContainer | |
![]() | getAttribute(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
![]() | getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML. | XMLStanza | |
![]() | getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML. | XMLStanza | |
getElementName():String
Gets the element name associated with this extension. | BrowseExtension | ||
![]() | getExtension(elementName:String):IExtension
Get the extension having the given element name. | ExtensionContainer | |
![]() | getField(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
getNS():String
Gets the namespace associated with this extension. | BrowseExtension | ||
![]() | removeAllExtensions(nameSpace:String):void | ExtensionContainer | |
![]() | removeExtension(extension:IExtension):Boolean | ExtensionContainer | |
![]() | removeFields(name:String):void
Helper method for removing all child elements that have the given name. | XMLStanza | |
![]() | setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML. | XMLStanza | |
![]() | setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML. | XMLStanza | |
![]() | setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | toString():String
Converts the base stanza XML to a string. | XMLStanza |
Constant | Defined By | ||
---|---|---|---|
![]() | DEFAULT_NS : Namespace [static]
Default XML namespace. | XMLStanza | |
ELEMENT_NAME : String = query [static] | BrowseExtension | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
NS : String = jabber:iq:browse [static] | BrowseExtension | ||
![]() | STREAM_NS : Namespace [static]
| XMLStanza |
items | property |
items:Array
[read-only] An array of BrowseItems containing information about the browsed resource
public function get items():Array
See also
BrowseExtension | () | Constructor |
public function BrowseExtension(parent:XML = null)
Parameters
parent:XML (default = null )
|
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
|
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".
ReturnsString |
getNS | () | method |
public function getNS():String
Gets the namespace associated with this extension. The namespace for the BrowseExtension is "jabber:iq:browse".
ReturnsString — The namespace
|
ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = query
NS | Constant |
public static const NS:String = jabber:iq:browse