Back to index

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

An interface describing a global application service that allows long duration (e.g. More...

import "nsIUpdateService.idl";

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

List of all members.

Public Member Functions

void registerTimer (in AString id, in nsITimerCallback callback, in unsigned long interval)
 Register an interval with the timer manager.

Detailed Description

An interface describing a global application service that allows long duration (e.g.

1-7 or more days, weeks or months) timers to be registered and then fired.

Definition at line 501 of file nsIUpdateService.idl.


Member Function Documentation

void nsIUpdateTimerManager::registerTimer ( in AString  id,
in nsITimerCallback  callback,
in unsigned long  interval 
)

Register an interval with the timer manager.

The timer manager periodically checks to see if the interval has expired and if it has calls the specified callback. This is persistent across application restarts and can handle intervals of long durations.

Parameters:
idAn id that identifies the interval, used for persistence
callbackA nsITimerCallback object that is notified when the interval expires
intervalThe length of time, in seconds, of the interval

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