Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIAbDirectoryQuery Interface Reference

import "nsIAbDirectoryQuery.idl";

Inheritance diagram for nsIAbDirectoryQuery:
Inheritance graph
[legend]
Collaboration diagram for nsIAbDirectoryQuery:
Collaboration graph
[legend]

List of all members.

Public Member Functions

long doQuery (in nsIAbDirectoryQueryArguments arguments, in nsIAbDirectoryQueryResultListener listener, in long resultLimit, in long timeOut)
 Initiates a query on a directory and sub-directories for properties on cards.
void stopQuery (in long contextID)
 Stops an existing query operation if query operation is asynchronous.

Detailed Description

Definition at line 201 of file nsIAbDirectoryQuery.idl.


Member Function Documentation

Initiates a query on a directory and sub-directories for properties on cards.

Parameters:
argumentsThe properties and values to match Value could of type nsIAbDirectoryQueryMatchItem for matches other than ?contains?
listenerThe listener which will obtain individual query results
resultLimitLimits the results returned to a specifed maximum value
Returns:
Unique number representing the context ID of the query

Stops an existing query operation if query operation is asynchronous.

The nsIAbDirectoryQueryResultListener will be notified when query has stopped

It is implementation specific if notification synchronous or asynchronous

Parameters:
contextIDThe unique number returned from the doQuery methods

The documentation for this interface was generated from the following file: