Back to index

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

import "calIAlarm.idl";

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

List of all members.

Public Member Functions

void makeImmutable ()
 Makes this alarm immutable.
calIAlarm clone ()
 Make a copy of this alarm.
boolean hasProperty (in AUTF8String name)
nsIVariant getProperty (in AUTF8String name)
void setProperty (in AUTF8String name, in nsIVariant value)
void deleteProperty (in AUTF8String name)

Public Attributes

readonly attribute boolean isMutable
 Returns true if this alarm is able to be modified.
attribute calIItemBase item
 The item this alarm is related to.
attribute AUTF8String action
 How this alarm is shown.
attribute calIDuration offset
 The offset between the item's date and the alarm time.
attribute calIDateTime alarmDate
 The absolute point in time the alarm should fire.
attribute unsigned long related
 One of the ALARM_RELATED constants below.
const unsigned long ALARM_RELATED_START = 0
 The alarm's offset should be based off of the startDate or entryDate (for events and tasks, respectively)
const unsigned long ALARM_RELATED_END = 1
 the alarm's offset should be based off of the endDate or dueDate (for events and tasks, respectively)
attribute calIDateTime lastAck
 The last time this alarm was fired and acknowledged by the user.
attribute unsigned long repeat
 Times the alarm should be repeated.
attribute calIDuration repeatOffset
 The duration between the alarm and each subsequent repeat.
readonly attribute calIDateTime repeatDate
 If repeat is specified, this helper returns the first DATETIME the alarm should be repeated on.
attribute AUTF8String description
 The description of the alarm.
attribute AUTF8String summary
 The summary of the alarm.
attribute AUTF8String icalString
 Manage Attendee for this alarm.
attribute calIcalComponent icalComponent
 The ical component of this VALARM.
readonly attribute
nsISimpleEnumerator 
propertyEnumerator

Detailed Description

Definition at line 48 of file calIAlarm.idl.


Member Function Documentation

Make a copy of this alarm.

The returned alarm will be mutable.

void calIAlarm::deleteProperty ( in AUTF8String  name)
nsIVariant calIAlarm::getProperty ( in AUTF8String  name)
boolean calIAlarm::hasProperty ( in AUTF8String  name)

Makes this alarm immutable.

void calIAlarm::setProperty ( in AUTF8String  name,
in nsIVariant  value 
)

Member Data Documentation

How this alarm is shown.

Special values as described in rfc2445 are AUDIO, DISPLAY, EMAIL In addition, custom actions may be defined as an X-Prop, i.e X-SMS.

Note that aside from setting this action, the frontend must be able to handle the specified action. Unknown actions WILL NOT be notified for.

Definition at line 79 of file calIAlarm.idl.

the alarm's offset should be based off of the endDate or dueDate (for events and tasks, respectively)

Definition at line 114 of file calIAlarm.idl.

The alarm's offset should be based off of the startDate or entryDate (for events and tasks, respectively)

Definition at line 108 of file calIAlarm.idl.

The absolute point in time the alarm should fire.

Setting the alarmDate will unset any specific offset. This means that the offset attribute will be relative to the item this alarm belongs to, or null if no item is set.

Definition at line 95 of file calIAlarm.idl.

The description of the alarm.

Not valid for AUDIO alarms.

Definition at line 147 of file calIAlarm.idl.

The ical component of this VALARM.

Definition at line 177 of file calIAlarm.idl.

Manage Attendee for this alarm.

Not valid for AUDIO and DISPLAY alarms. Manage Attachments for this alarm. For EMAIL alarms, more than one attachment can be specified. For AUDIO alarms, one Attachment can be specified. For DISPLAY alarms, attachments are invalid. The ical representation of this VALARM

Definition at line 172 of file calIAlarm.idl.

Returns true if this alarm is able to be modified.

Definition at line 53 of file calIAlarm.idl.

The item this alarm is related to.

Definition at line 68 of file calIAlarm.idl.

The last time this alarm was fired and acknowledged by the user.

Definition at line 119 of file calIAlarm.idl.

The offset between the item's date and the alarm time.

Setting an offset unsets any specific absolute date set. This means that the alarmDate attribute will be calculated with the offset and the item's date and be null if no item is set.

Definition at line 87 of file calIAlarm.idl.

Definition at line 185 of file calIAlarm.idl.

One of the ALARM_RELATED constants below.

If an alarmDate was set, changing this influences the offset, and vice versa.

Definition at line 102 of file calIAlarm.idl.

Times the alarm should be repeated.

This value is the number of ADDITIONAL alarms, aside from the actual alarm.

For the alarm to be valid, if repeat is specified, the repeatOffset attribute MUST also be specified.

Definition at line 128 of file calIAlarm.idl.

If repeat is specified, this helper returns the first DATETIME the alarm should be repeated on.

Definition at line 142 of file calIAlarm.idl.

The duration between the alarm and each subsequent repeat.

For the alarm to be valid, if repeatOffset is specified, the repeat attribute MUST also be specified.

Definition at line 136 of file calIAlarm.idl.

The summary of the alarm.

Not valid for AUDIO and DISPLAY alarms.

Definition at line 152 of file calIAlarm.idl.


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