Implement the methods in this interface to augment or override the default calendar lookup (LDAP).
The csICalendarLookup implements the following methods:
Method |
Description |
---|---|
Removes the host name entry from the calendar lookup database for a specific calendar. |
|
Frees a previously allocated, fully qualified calid. |
|
Frees a previously allocated type. |
|
Gets the hostname from the calendar lookup database associated with the calendar specified by the calid |
|
Confirms that the interface was found and registered. |
|
Returns the name of the qualified calid. |
|
Queries the type of plug-in. |
|
Sets the host name for a calendar user associated with a calid being created. |
Allows you to control calendar lookup by implementing one or more of the methods.
The four possible return codes for the piReturnCode parameter are as follows:
Cannot connect to LDAP server
Insufficient privileges to modify LDAP entry
Invalid credentials to connect to LDAP
No value for back end host
Removes the hostname in LDAP associated with the specified calid.
PRInt32 GetHostnameForCalid(char* psCalid, PRInt32 *piReturnCode)=0;
The following are the parameters and definitions for this method:
psCalid |
calid for which the hostname is requested. |
piReturnCode |
0= successful, non-zero indicates failure. |
Returns zero for success. Returns a non-zero code for failure. See API: csICalendarLookup.
Removes the hostname associated with the specified calendar in the calendar lookup database.
Frees a previously allocated, fully qualified calendar ID (calid).
PRUint32 FreeCalid(char** aQualifiedCalid,PRInt32 *aReturnCode)=0;
The method has the following parameters:
aQualifiedCalid |
calid to free. |
aReturnCode |
NS_OK if successful. Normal processing does not continue if unsuccessful. |
NS_OK on success, non-zero error code on failure.
Used by both implementations of lookup.
Frees a previously allocated database plug-in type.
PRUint32 FreeType(char* aType,PRInt32 *aReturnCode)=0;
The method has the following parameters:
aType |
The database plug-in type to free |
aReturnCode |
NS_OK if successful. Normal processing does not continue if unsuccessful. |
NS_OK on success, non-zero error code on failure.
Frees the string allocated in QueryType method. Used by both implementations.
Retrieves the hostname associated with the specified calid.
PRInt32 GetHostnameForCalid(char* psCalid, char** ppsHost, PRInt32 *piReturnCode)=0;
The following are the parameters and definitions for this method:
psCalid |
calid for which the hostname is requested. |
ppsHost |
The hostname to be returned. |
piReturnCode |
0= successful, non-zero indicates failure. |
Returns zero for success. Returns a non-zero code for failure. See API: csICalendarLookup.
Gets the hostname associated with a calendar in the calendar lookup database.
Confirms that the interface has been registered, and provides a reference to the server.
PRUint32 Init(nsISupports *aServer)=0;
The method has the following parameter:
aServer |
On return, contains a reference to the server with which the module is registered. |
NS_OK on success, non-zero error code on failure.
The server calls this method after finding and registering the interface on module load, to confirm that the operation was successful. You can use the pointer returned in aServer to make calls out to the server.
Qualifies the relative calid.
PRUint32 QualifyCalid(char* psCalid, char** ppsQualifiedCalid, PRInt32 *piReturnCode)=0;
The method has the following parameters:
psCalid |
The calid to be qualified. |
ppsQualifiedCalid |
On return, contains the URL of the qualified calid. |
piReturnCode |
0= successful, non-zero indicates failure. |
Zero on success, non-zero error code on failure.
Returns the name of the qualified calid. The qualified calid format is:
dwp://back-end host[:port]/psCalid |
Query type of database plug-in.
PRUint32 QueryType(char* aType,PRInt32 *aReturnCode)=0;
The method has the following parameters:
aType |
The type of CLD (Calendar Lookup Database). |
aReturnCode |
NS_OK if successful. Normal processing does not continue if unsuccessful. |
NS_OK on success, non-zero error code on failure.
This function retrieves a string representing the type of CLD the plug-in implements.
Not currently used. Sets the host name for a calendar user.
PRInt32 SetHostnameForCalid(char* psCalid, char* ppsHost, PRInt32 *piReturnCode)=0; |
This method uses the following parameters:
psCalid |
calid for which the hostname is to be set. |
ppsHost |
The hostname to be set. |
piReturnCode |
0= successful, non-zero indicates failure. |
Returns zero for success. Returns any non-zero for failure.
Sets the hostname for a calid that is about to be created.