Back to index

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

Async operations are called back via this interface. More...

import "calICalendar.idl";

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

List of all members.

Public Member Functions

void onOperationComplete (in calICalendar aCalendar, in nsresult aStatus, in unsigned long aOperationType, in string aId, in nsIVariant aDetail)
 For add, modify, and delete.
void onGetResult (in calICalendar aCalendar, in nsresult aStatus, in nsIIDRef aItemType, in nsIVariant aDetail, in PRUint32 aCount,[array, size_is(aCount), iid_is(aItemType)] in nsQIResult aItems)
 For getItem and getItems.

Public Attributes

const unsigned long ADD = 1
const unsigned long MODIFY = 2
const unsigned long DELETE = 3
const unsigned long GET = 4

Detailed Description

Async operations are called back via this interface.

If you know that your object is not going to get called back for either of these methods, having them return NS_ERROR_NOT_IMPLEMENTED is reasonable.

Definition at line 570 of file calICalendar.idl.


Member Function Documentation

void calIOperationListener::onGetResult ( in calICalendar  aCalendar,
in nsresult  aStatus,
in nsIIDRef  aItemType,
in nsIVariant  aDetail,
in PRUint32  aCount,
[array, size_is(aCount), iid_is(aItemType)] in nsQIResult  aItems 
)

For getItem and getItems.

Parameters:
aStatusstatus code summarizing what happened.
aItemTypetype of interface returned in the array (
See also:
calICalendar::GetItems).
Parameters:
aDetailnot yet fully specified. If aStatus is an error result, this will probably be an extended error string (eg one returned by a server).
aCountsize of array returned, in items
aItemsarray of immutable items

Multiple onGetResults might be called

void calIOperationListener::onOperationComplete ( in calICalendar  aCalendar,
in nsresult  aStatus,
in unsigned long  aOperationType,
in string  aId,
in nsIVariant  aDetail 
)

For add, modify, and delete.

Parameters:
aCalendarthe calICalendar on which the operation took place
aStatusstatus code summarizing what happened
aOperationTypetype of operation that was completed
aIdUUID of element that was changed
aDetailnot yet fully specified. If aStatus is an error result, this will probably be an extended error string (eg one returned by a server).

Member Data Documentation

Definition at line 588 of file calICalendar.idl.

Definition at line 590 of file calICalendar.idl.

Definition at line 591 of file calICalendar.idl.

Definition at line 589 of file calICalendar.idl.


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