| Package | org.igniterealtime.xiff.data.browse |
| Class | public class BrowseExtension |
| Inheritance | BrowseExtension BrowseItem XMLStanza ExtensionContainer |
| Implements | IExtension |
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 | |
![]() | _exts : Object | ExtensionContainer | |
| 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
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 | |
![]() | XMLData : XML [static]
| XMLStanza | |
![]() | XMLFactory : XMLDocument [static]
| XMLStanza | |
| Method | Defined by | ||
|---|---|---|---|
|
BrowseExtension(parent:XMLNode = null)
| BrowseExtension | ||
![]() | 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):XMLNode
Add new features that are supported if you are responding to a
browse request
| BrowseItem | |
![]() |
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 | ||
![]() |
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
| XMLStanza | |
![]() |
exists(value:*):Boolean
[static]
A helper method to determine if a value is both not null
and not undefined.
| XMLStanza | |
![]() |
getAllExtensions():Array
| ExtensionContainer | |
![]() |
getAllExtensionsByNS(ns:String):Array
| ExtensionContainer | |
|
getElementName():String
Gets the element name associated with this extension.
| BrowseExtension | ||
![]() |
getExtension(name:String):Extension
| ExtensionContainer | |
![]() |
getNode():XMLNode
| XMLStanza | |
|
getNS():String
Gets the namespace associated with this extension.
| BrowseExtension | ||
![]() |
removeAllExtensions(ns:String):void
| ExtensionContainer | |
![]() |
removeExtension(ext:IExtension):Boolean
| ExtensionContainer | |
![]() |
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 | ||
![]() |
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
| XMLStanza | |
| Constant | Defined by | ||
|---|---|---|---|
| ELEMENT_NAME : String = "query" [static]
| BrowseExtension | ||
| NS : String = "jabber:iq:browse" [static]
| BrowseExtension | ||
| items | property |
items:Array [read-only]An array of BrowseItems containing information about the browsed resource
Implementation public function get items():Array
See also
| BrowseExtension | () | constructor |
public function BrowseExtension(parent:XMLNode = null)Parameters
parent:XMLNode (default = null) |
| addItem | () | method |
public function addItem(item:BrowseItem):BrowseItemIf you are generating a browse response to a browse request, then fill out the items list with this method.
Parametersitem:BrowseItem — BrowseItem which contains the info related to the browsed resource
|
BrowseItem —
the item added
|
See also
| deserialize | () | method |
public override function deserialize(node:XMLNode):BooleanISerializable implementation which saves this extension to XML
Parametersnode:XMLNode |
Boolean |
See also
| enable | () | method |
public static function enable():voidPerforms the registration of this extension into the extension registry.
| getElementName | () | method |
public function getElementName():StringGets the element name associated with this extension. The element for this extension is "query".
ReturnsString |
| getNS | () | method |
public function getNS():StringGets the namespace associated with this extension. The namespace for the BrowseExtension is "jabber:iq:browse".
ReturnsString — The namespace
|
| serialize | () | method |
public override function serialize(parentNode:XMLNode):BooleanISerializable implementation which loads this extension from XML
ParametersparentNode:XMLNode |
Boolean |
See also
| ELEMENT_NAME | constant |
public static const ELEMENT_NAME:String = "query"
| NS | constant |
public static const NS:String = "jabber:iq:browse"