Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
calICalendarSearchService Interface Reference

This service acts as a central access point for calendar lookup. More...

import "calICalendarSearchProvider.idl";

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

List of all members.

Public Member Functions

void getProviders (out PRUint32 aCount,[array, size_is(aCount), retval] out calICalendarSearchProvider aProviders)
 Gets the currently registered set of search providers.
void addProvider (in calICalendarSearchProvider aProvider)
 Adds a new search provider.
void removeProvider (in calICalendarSearchProvider aProvider)
 Removes a search provider.
calIOperation searchForCalendars (in AUTF8String aString, in unsigned long aHints, in unsigned long aMaxResults, in calIGenericOperationListener aListener)
 Searches for calendars matching the specified search string.

Public Attributes

const unsigned long HINT_EXACT_MATCH = 1
 Specifies whether the search string should exactly match.

Detailed Description

This service acts as a central access point for calendar lookup.

A search request will be multiplexed to all added search providers. Adding a search provider is transient.

Definition at line 81 of file calICalendarSearchProvider.idl.


Member Function Documentation

Adds a new search provider.

void calICalendarSearchService::getProviders ( out PRUint32  aCount,
[array, size_is(aCount), retval] out calICalendarSearchProvider  aProviders 
)

Gets the currently registered set of search providers.

Removes a search provider.

calIOperation calICalendarSearchProvider::searchForCalendars ( in AUTF8String  aString,
in unsigned long  aHints,
in unsigned long  aMaxResults,
in calIGenericOperationListener  aListener 
) [inherited]

Searches for calendars matching the specified search string.

It's up to the search provider what properties of a calendar it takes into account for the search. The passed hints serve for optimization purposes. Callers need to keep in mind that providers may not be able to implement all of the stated hints passed, thus are required to filter further if necessary. Results are notified to the passed listener interface.

Parameters:
aStringsearch string to match
aHintssearch hints
aMaxResultsmaximum number of results (0 denotes provider specific maximum)
aListenercalled with an array of calICalendar objects
Returns:
optional operation handle to track the operation

Member Data Documentation

Specifies whether the search string should exactly match.

Definition at line 49 of file calICalendarSearchProvider.idl.


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