Back to index

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

import "calITodo.idl";

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

List of all members.

Public Member Functions

void makeImmutable ()
calIItemBase clone ()
boolean hasSameIds (in calIItemBase aItem)
 Checks whether the argument object refers the same calendar item as this one, by testing both the id and recurrenceId property.
void updateStampTime ()
boolean hasProperty (in AString name)
nsIVariant getProperty (in AString name)
void setProperty (in AString name, in nsIVariant value)
void deleteProperty (in AString name)
boolean isPropertyPromoted (in AString name)
AString getPropertyParameter (in AString aPropertyName, in AString aParameterName)
 Returns a particular parameter value for a property, or null if the parameter does not exist.
void getAttendees (out PRUint32 count,[array, size_is(count), retval] out calIAttendee attendees)
calIAttendee getAttendeeById (in AUTF8String id)
 getAttendeeById's matching is done in a case-insensitive manner to handle places where "MAILTO:" or similar properties are capitalized arbitrarily by different calendar clients.
void removeAttendee (in calIAttendee attendee)
void addAttendee (in calIAttendee attendee)
void removeAllAttendees ()
void getAttachments (out PRUint32 count,[array, size_is(count), retval] out calIAttachment attachments)
void removeAttachment (in calIAttachment attachment)
void addAttachment (in calIAttachment attachment)
void removeAllAttachments ()
void getCategories (out PRUint32 aCount,[array, size_is(aCount), retval] out wstring aCategories)
 Gets the array of categories this item belongs to.
void setCategories (in PRUint32 aCount,[array, size_is(aCount)] in wstring aCategories)
 Sets the array of categories this item belongs to.
void getRelations (out PRUint32 count,[array, size_is(count), retval] out calIRelation relations)
 This gives back every relation where the item is neighter the owner of the relation nor the referred relation.
void removeRelation (in calIRelation relation)
 Removes the relation for this item and the referred item.
void removeAllRelations ()
 Removes every relation for this item (in this items and also where it is referred.
void addRelation (in calIRelation relation)
 Adds a relation to the item.
void getOccurrencesBetween (in calIDateTime aStartDate, in calIDateTime aEndDate, out PRUint32 aCount,[array, size_is(aCount), retval] out calIItemBase aOccurrences)
 Return a list of occurrences of this item between the given dates.

Public Attributes

const long CAL_TODO_STATUS_NEEDSACTION = 4
const long CAL_TODO_STATUS_COMPLETED = 5
const long CAL_TODO_STATUS_INPROCESS = 6
attribute calIDateTime entryDate
attribute calIDateTime dueDate
attribute calIDateTime completedDate
attribute short percentComplete
attribute boolean isCompleted
readonly attribute calIDuration duration
 The duration of the todo, which is defined as dueDate - entryDate.
readonly attribute boolean isMutable
readonly attribute AUTF8String hashId
 Hash Id that incorporates the item's UID, RECURRENCE-ID and calendar.id to be used for lookup of items that come from different calendars.
attribute PRUint32 generation
readonly attribute calIDateTime creationDate
readonly attribute calIDateTime lastModifiedTime
readonly attribute calIDateTime stampTime
attribute calICalendar calendar
attribute AUTF8String id
attribute AUTF8String title
attribute short priority
attribute AUTF8String privacy
attribute AUTF8String status
attribute AUTF8String icalString
attribute calIIcalComponent icalComponent
attribute calIDuration alarmOffset
 The amount of time from the date (specified by alarmRelated) to offset the alarm's firing time by.
attribute unsigned long alarmRelated
 One of the ALARM_RELATED constants below.
const unsigned long ALARM_RELATED_START = 0
 Corresponds to an alarmOffset that should be based off of the startDate or entryDate (for events and tasks, respectively)
const unsigned long ALARM_RELATED_END = 1
 Corresponds to an alarmOffset that should be based off of the endDate or dueDate (for events and tasks, respectively)
attribute calIDateTime alarmLastAck
attribute calIRecurrenceInfo recurrenceInfo
readonly attribute calIDateTime recurrenceStartDate
readonly attribute
nsISimpleEnumerator 
propertyEnumerator
attribute calIAttendee organizer
 The organizer (originator) of the item.
attribute calIItemBase parentItem
 If this item is a proxy or overridden item, parentItem will point upwards to our parent.
attribute calIDateTime recurrenceId
 The recurrence ID, a.k.a.

Detailed Description

Definition at line 48 of file calITodo.idl.


Member Function Documentation

void calIItemBase::addAttachment ( in calIAttachment  attachment) [inherited]
void calIItemBase::addAttendee ( in calIAttendee  attendee) [inherited]
void calIItemBase::addRelation ( in calIRelation  relation) [inherited]

Adds a relation to the item.

void calIItemBase::deleteProperty ( in AString  name) [inherited]
void calIItemBase::getAttachments ( out PRUint32  count,
[array, size_is(count), retval] out calIAttachment  attachments 
) [inherited]
calIAttendee calIItemBase::getAttendeeById ( in AUTF8String  id) [inherited]

getAttendeeById's matching is done in a case-insensitive manner to handle places where "MAILTO:" or similar properties are capitalized arbitrarily by different calendar clients.

void calIItemBase::getAttendees ( out PRUint32  count,
[array, size_is(count), retval] out calIAttendee  attendees 
) [inherited]
void calIItemBase::getCategories ( out PRUint32  aCount,
[array, size_is(aCount), retval] out wstring  aCategories 
) [inherited]

Gets the array of categories this item belongs to.

void calIItemBase::getOccurrencesBetween ( in calIDateTime  aStartDate,
in calIDateTime  aEndDate,
out PRUint32  aCount,
[array, size_is(aCount), retval] out calIItemBase  aOccurrences 
) [inherited]

Return a list of occurrences of this item between the given dates.

The items returned are the same type as this one, as proxies.

nsIVariant calIItemBase::getProperty ( in AString  name) [inherited]
AString calIItemBase::getPropertyParameter ( in AString  aPropertyName,
in AString  aParameterName 
) [inherited]

Returns a particular parameter value for a property, or null if the parameter does not exist.

If the property does not exist, throws.

Parameters:
aPropertyNamethe name of the property
aParameterNamethe name of the parameter on the property
void calIItemBase::getRelations ( out PRUint32  count,
[array, size_is(count), retval] out calIRelation  relations 
) [inherited]

This gives back every relation where the item is neighter the owner of the relation nor the referred relation.

boolean calIItemBase::hasProperty ( in AString  name) [inherited]

Checks whether the argument object refers the same calendar item as this one, by testing both the id and recurrenceId property.

This

  • aItem the item to compare against this one
Returns:
true if both ids match, false otherwise
boolean calIItemBase::isPropertyPromoted ( in AString  name) [inherited]

Removes every relation for this item (in this items and also where it is referred.

void calIItemBase::removeAttendee ( in calIAttendee  attendee) [inherited]
void calIItemBase::removeRelation ( in calIRelation  relation) [inherited]

Removes the relation for this item and the referred item.

void calIItemBase::setCategories ( in PRUint32  aCount,
[array, size_is(aCount)] in wstring  aCategories 
) [inherited]

Sets the array of categories this item belongs to.

void calIItemBase::setProperty ( in AString  name,
in nsIVariant  value 
) [inherited]

Member Data Documentation

const unsigned long calIItemBase::ALARM_RELATED_END = 1 [inherited]

Corresponds to an alarmOffset that should be based off of the endDate or dueDate (for events and tasks, respectively)

Definition at line 170 of file calIItemBase.idl.

const unsigned long calIItemBase::ALARM_RELATED_START = 0 [inherited]

Corresponds to an alarmOffset that should be based off of the startDate or entryDate (for events and tasks, respectively)

Definition at line 164 of file calIItemBase.idl.

Definition at line 173 of file calIItemBase.idl.

The amount of time from the date (specified by alarmRelated) to offset the alarm's firing time by.

Definition at line 153 of file calIItemBase.idl.

One of the ALARM_RELATED constants below.

Definition at line 158 of file calIItemBase.idl.

Definition at line 51 of file calITodo.idl.

Definition at line 52 of file calITodo.idl.

Definition at line 50 of file calITodo.idl.

Definition at line 121 of file calIItemBase.idl.

Definition at line 70 of file calITodo.idl.

Definition at line 109 of file calIItemBase.idl.

Definition at line 69 of file calITodo.idl.

The duration of the todo, which is defined as dueDate - entryDate.

Please note that null is returned if either entryDate or dueDate don't exist.

Definition at line 103 of file calITodo.idl.

Definition at line 68 of file calITodo.idl.

Definition at line 106 of file calIItemBase.idl.

readonly attribute AUTF8String calIItemBase::hashId [inherited]

Hash Id that incorporates the item's UID, RECURRENCE-ID and calendar.id to be used for lookup of items that come from different calendars.

Setting either id, recurrenceId or the calendar attribute leads to a recomputation of hashId.

Attention:
Individual implementors of calIItemBase must stick to the same algorithm that base/src/calItemBase.js uses.

Definition at line 91 of file calIItemBase.idl.

Definition at line 143 of file calIItemBase.idl.

attribute AUTF8String calIItemBase::icalString [inherited]

Definition at line 138 of file calIItemBase.idl.

attribute AUTF8String calIItemBase::id [inherited]

Definition at line 124 of file calIItemBase.idl.

Definition at line 96 of file calITodo.idl.

Definition at line 74 of file calIItemBase.idl.

Definition at line 112 of file calIItemBase.idl.

The organizer (originator) of the item.

We will likely not honour or preserve all fields in the calIAttendee passed around here. A base class like calIPerson might be more appropriate here, if we ever grow one.

Definition at line 240 of file calIItemBase.idl.

If this item is a proxy or overridden item, parentItem will point upwards to our parent.

Otherwise, it will point to this. parentItem can thus always be used for modifyItem() calls to providers.

Definition at line 329 of file calIItemBase.idl.

Definition at line 71 of file calITodo.idl.

attribute short calIItemBase::priority [inherited]

Definition at line 130 of file calIItemBase.idl.

attribute AUTF8String calIItemBase::privacy [inherited]

Definition at line 131 of file calIItemBase.idl.

Definition at line 213 of file calIItemBase.idl.

The recurrence ID, a.k.a.

DTSTART-of-calculated-occurrence, or null if this isn't an occurrence. Be conservative about setting this. It isn't marked as such, but consider it as readonly.

Definition at line 337 of file calIItemBase.idl.

Definition at line 178 of file calIItemBase.idl.

Definition at line 179 of file calIItemBase.idl.

Definition at line 115 of file calIItemBase.idl.

attribute AUTF8String calIItemBase::status [inherited]

Definition at line 134 of file calIItemBase.idl.

attribute AUTF8String calIItemBase::title [inherited]

Definition at line 127 of file calIItemBase.idl.


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