Back to index

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

import "calIAlarmService.idl";

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

List of all members.

Public Member Functions

void startup ()
 Cause the alarm service to start up, create a list of upcoming alarms in all registered calendars, add observers to watch for calendar registration and unregistration, and setup a timer to maintain that list and fire alarms.
void addObserver (in calIAlarmServiceObserver observer)
void removeObserver (in calIAlarmServiceObserver observer)
void snoozeAlarm (in calIItemBase item, in calIDuration duration)
void dismissAlarm (in calIItemBase item)
 Dismisses an alarm corresponding to the passed item.

Public Attributes

attribute calITimezone timezone
 This is the timezone that all-day events will be converted to in order to determine when their alarms should fire.

Detailed Description

Definition at line 68 of file calIAlarmService.idl.


Member Function Documentation

Dismisses an alarm corresponding to the passed item.

Cause the alarm service to start up, create a list of upcoming alarms in all registered calendars, add observers to watch for calendar registration and unregistration, and setup a timer to maintain that list and fire alarms.

Note:
Will throw NS_ERROR_NOT_INITIALIZED if you have not previously set the timezone attribute.

Member Data Documentation

This is the timezone that all-day events will be converted to in order to determine when their alarms should fire.

Definition at line 74 of file calIAlarmService.idl.


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