class Browser

Object | +--org.jivesoftware.xiff.core.Browser

class Browser extends Object

Provides a means of quering for available services on an XMPP server using the Disco protocol extension. For more information on Disco, take a look at JEP-0030 and JEP-0011 for the protocol enhancement specifications.

Author:
Sean Treadway
Since:
2.0.0

Property Summary

public connection: XMPPConnection (read, write)

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

Constructor

public Browser ( conn: XMPPConnection)

Method Summary

public browseItem ( id: String, callback: String, scope: Object )

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

public getNodeInfo ( service: String, node: String, callback: String, scope: Object ): Void

public getNodeItems ( service: String, node: String, callback: String, scope: Object ): Void

public getServiceInfo ( server: String, callback: String, scope: Object ): Void

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.

public getServiceItems ( server: String, callback: String, scope: Object ): Void

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.

Property Documentation

connection

public connection: XMPPConnection (read, write)

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

Constructor Documentation

Browser

public function Browser (

conn: XMPPConnection)

Method Documentation

browseItem

public function browseItem (

id: String,
callback: String,
scope: Object)

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

Parameters:
id
The full JabberID to query for service items
callback
The name of a callback function to call when results are retrieved
scope
The scope of the callback function

Parameters:
server
The server to query for available service information
callback
The name of a callback function to call when results are retrieved
scope
The scope of the callback function

getServiceItems

public function getServiceItems (

server: String,
callback: String,
scope: Object): Void

Parameters:
server
The server to query for service items
callback
The name of a callback function to call when results are retrieved
scope
The scope of the callback function

The documentation was generated from the following file:

Browser.as, Last Modified: 3/10/2005 10:07:28 PM

id		The full JabberID to query for service items
callback		The name of a callback function to call when results are retrieved
scope		The scope of the callback function

server		The server to query for available service information
callback		The name of a callback function to call when results are retrieved
scope		The scope of the callback function

server		The server to query for service items
callback		The name of a callback function to call when results are retrieved
scope		The scope of the callback function