Interface nsIUpdateTimerManagerType

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.

Hierarchy

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • 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. The callback will be called soon after the first registration unless you ask to skip it.

    Parameters

    • id: string

      An id that identifies the interval, used for persistence

    • callback: nsITimerCallback

      A nsITimerCallback object that is notified when the interval expires

    • interval: number

      The length of time, in seconds, of the interval

    • skipFirst: boolean

      Whether to skip the initial callback on first registration.

      Note: to avoid having to instantiate a component to call registerTimer the component can intead register an update-timer category with comma separated values as a single string:

      contractID,method,id,preference,interval

      via a manifest entry. The values are as follows: contractID : the contract ID for the component. method : the method used to instantiate the interface. This should be either getService or createInstance depending on your component. id : the id that identifies the interval, used for persistence. preference : the preference to for timer interval. This value can be optional by specifying an empty string for the value. interval : the default interval in seconds for the timer.

    Returns void

  • Unregister an existing interval from the timer manager.

    Parameters

    • id: string

      An id that identifies the interval.

    Returns void

Generated using TypeDoc