Back to index

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

Accesses scheduling specific information of calendar items. More...

import "calISchedulingSupport.idl";

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

List of all members.

Public Member Functions

boolean isInvitation (in calIItemBase aItem)
 Tests whether the passed item corresponds to an invitation, e.g.
calIAttendee getInvitedAttendee (in calIItemBase aItem)
 Gets the invited attendee if the passed item corresponds to an invitation.
boolean canNotify (in AUTF8String aMethod, in calIItemBase aItem)
 Checks whether the provider keeps track of sending out the proper iTIP/iMIP message for a particular item.

Detailed Description

Accesses scheduling specific information of calendar items.

Implementation by providers is optional.

Definition at line 47 of file calISchedulingSupport.idl.


Member Function Documentation

boolean calISchedulingSupport::canNotify ( in AUTF8String  aMethod,
in calIItemBase  aItem 
)

Checks whether the provider keeps track of sending out the proper iTIP/iMIP message for a particular item.

Parameters:
aMethoda iTIP method
aIteman item that has been modified/deleted etc.
Returns:
true, if the provider keeps track of sending out passed message

Gets the invited attendee if the passed item corresponds to an invitation.

UI code will use that attendee to modify e.g. PARTSTAT. If isInvitation returns true, getInvitedAttendee must return an attendee. If isInvitation is false, getInvitedAttendee may return an attendee in case the organizer (and owner of the calendar) has invited himself.

Parameters:
aItemInvitation item.
Returns:
Attendee object, or null.

Tests whether the passed item corresponds to an invitation, e.g.

the CUA or server has placed it in the calendar.

Parameters:
aItemItem to be tested.
Returns:
Whether the passed item corresponds to an invitation.

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