Packageorg.igniterealtime.xiff.core
Classpublic class Browser
ImplementsIBrowser

This class provides a means of querying for available services on an XMPP server using the Disco protocol extension. For more information on Disco, take a look at XEP-0030 and XEP-0011 for the protocol enhancement specifications.



Public Properties
 PropertyDefined by
  connection : IXMPPConnection
The instance of the XMPPConnection class to use for sending and receiving data.
Browser
Public Methods
 MethodDefined by
  
Browser(aConnection:IXMPPConnection)
Creates a new Browser object.
Browser
  
browseItem(id:EscapedJID, callback:Function, errorCallback:Function = null):IIQ
Use the BrowseExtension (jabber:iq:browse namespace) to query a resource for supported features and children.
Browser
  
getNodeInfo(service:EscapedJID, node:String, callback:Function, errorCallback:Function = null):IIQ
Browser
  
getNodeItems(service:EscapedJID, node:String, callback:Function, errorCallback:Function = null):IIQ
Browser
  
getServiceInfo(server:EscapedJID, callback:Function, errorCallback:Function = null):IIQ
Retrieves a list of available service information from the server specified.
Browser
  
getServiceItems(server:EscapedJID, callback:Function, errorCallback:Function = null):IIQ
Retrieves a list of available services items from the server specified.
Browser
Property detail
connectionproperty
connection:IXMPPConnection  [read-write]

The instance of the XMPPConnection class to use for sending and receiving data.

Implementation
    public function get connection():IXMPPConnection
    public function set connection(value:IXMPPConnection):void
Constructor detail
Browser()constructor
public function Browser(aConnection:IXMPPConnection)

Creates a new Browser object.

Parameters
aConnection:IXMPPConnection — A reference to the XMPPConnection instance to use.
Method detail
browseItem()method
public function browseItem(id:EscapedJID, callback:Function, errorCallback:Function = null):IIQ

Use the BrowseExtension (jabber:iq:browse namespace) to query a resource for supported features and children.

Parameters
id:EscapedJID — The full JabberID to query for service items
 
callback:Function — The callback function to call when results are retrieved
 
errorCallback:Function (default = null) — The callback function to call when errors are received

Returns
IIQ
getNodeInfo()method 
public function getNodeInfo(service:EscapedJID, node:String, callback:Function, errorCallback:Function = null):IIQParameters
service:EscapedJID
 
node:String
 
callback:Function
 
errorCallback:Function (default = null)

Returns
IIQ
getNodeItems()method 
public function getNodeItems(service:EscapedJID, node:String, callback:Function, errorCallback:Function = null):IIQParameters
service:EscapedJID
 
node:String
 
callback:Function
 
errorCallback:Function (default = null)

Returns
IIQ
getServiceInfo()method 
public function getServiceInfo(server:EscapedJID, callback:Function, errorCallback:Function = null):IIQ

Retrieves a list of available service information from the server specified. On successful query, the callback specified will be called and passed a single parameter containing a reference to an IQ containing the query results.

Parameters
server:EscapedJID — The server to query for available service information
 
callback:Function — The callback function to call when results are retrieved
 
errorCallback:Function (default = null) — The callback function to call when errors are received

Returns
IIQ
getServiceItems()method 
public function getServiceItems(server:EscapedJID, callback:Function, errorCallback:Function = null):IIQ

Retrieves a list of available services items from the server specified. Items include things such as available transports and user directories. On successful query, the callback specified in the will be called and passed a single parameter containing the query results.

Parameters
server:EscapedJID — The server to query for service items
 
callback:Function — The callback function to call when results are retrieved
 
errorCallback:Function (default = null) — The callback function to call when errors are received

Returns
IIQ