Interface nsIUpdateManagerType

An interface describing a global application service that maintains a list of updates previously performed as well as the current active update.

Hierarchy

Properties

downloadingUpdate readyUpdate

Methods

AddRef QueryInterface Release addUpdateToHistory cleanupDownloadingUpdate cleanupReadyUpdate elevationOptedIn getUpdateAt getUpdateCount refreshUpdateStatus saveUpdates

Properties

downloadingUpdate

downloadingUpdate: nsIUpdate

The update that is currently downloading, or null if there isn't one. An update is no longer considered to be downloading once onStopRequest is called. This means that both onStopRequest handlers for download listeners and observers of the "update-downloaded" topic should expect the update that was just downloaded to be stored in readyUpdate, not downloadingUpdate.

readyUpdate

readyUpdate: nsIUpdate

The update that has been downloaded, or null if there isn't one.

Methods

AddRef

  • 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

QueryInterface

  • 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

Release

  • 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

addUpdateToHistory

  • Adds the specified update to the update history. The update history is limited to 10 items, so this may also remove the last item from the history.

    Parameters

    • update: nsIUpdate

    Returns void

cleanupDownloadingUpdate

  • These functions both clean up and remove an active update without applying it. The first function does this for the update that is currently being downloaded. The second function does this for the update that has already been downloaded.

    Returns void

cleanupReadyUpdate

  • Returns void

elevationOptedIn

  • The user agreed to proceed with an elevated update and we are now permitted to show an elevation prompt.

    Returns void

getUpdateAt

  • Gets the update at the specified index

    Returns

    The nsIUpdate object at the specified index

    Parameters

    • index: number

      The index within the updates array

    Returns nsIUpdate

getUpdateCount

  • Gets the total number of updates in the history list.

    Returns number

refreshUpdateStatus

  • Refresh the update status based on the information in update.status.

    Returns

    A Promise that resolves after the update status is refreshed.

    Returns any

saveUpdates

  • Saves all updates to disk.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc