Struct xpcom::interfaces::nsIApplicationUpdateService [] [src]

#[repr(C)]
pub struct nsIApplicationUpdateService { /* fields omitted */ }

interface nsIApplicationUpdateService : nsISupports

/**
 * An interface describing a global application service that handles performing
 * background update checks and provides utilities for selecting and
 * downloading update patches.
 */

Methods

impl nsIApplicationUpdateService
[src]

[src]

Cast this nsIApplicationUpdateService to one of its base interfaces.

impl nsIApplicationUpdateService
[src]

[src]

/**
   * Checks for available updates in the background using the listener provided
   * by the application update service for background checks.
   */

void checkForBackgroundUpdates ();

[src]

/**
   * The Update Checker used for background update checking.
   */

readonly attribute nsIUpdateChecker backgroundChecker;

[src]

/**
   * Selects the best update to install from a list of available updates.
   * @param   updates
   *          An array of updates that are available
   * @param   updateCount
   *          The length of the |updates| array
   */

nsIUpdate selectUpdate ([array, size_is (updateCount)] in nsIUpdate updates, in unsigned long updateCount);

[src]

/**
   * Adds a listener that receives progress and state information about the
   * update that is currently being downloaded, e.g. to update a user
   * interface.
   * @param   listener
   *          An object implementing nsIRequestObserver and optionally
   *          nsIProgressEventSink that is to be notified of state and
   *          progress information as the update is downloaded.
   */

void addDownloadListener (in nsIRequestObserver listener);

[src]

/**
   * Removes a listener that is receiving progress and state information
   * about the update that is currently being downloaded.
   * @param   listener
   *          The listener object to remove.
   */

void removeDownloadListener (in nsIRequestObserver listener);

[src]

/**
   *
   */

AString downloadUpdate (in nsIUpdate update, in boolean background);

[src]

/**
   * Get the Active Updates directory
   * @returns An nsIFile for the active updates directory.
   */

nsIFile getUpdatesDirectory ();

[src]

/**
   * Pauses the active update download process
   */

void pauseDownload ();

[src]

/**
   * Whether or not there is an download happening at the moment.
   */

readonly attribute boolean isDownloading;

[src]

/**
   * Whether or not the Update Service can check for updates. This is a function
   * of whether or not application update is disabled by the application and the
   * platform the application is running on.
   */

readonly attribute boolean canCheckForUpdates;

[src]

/**
   * Whether or not the installation requires elevation. Currently only
   * implemented on OSX, returns false on other platforms.
   */

readonly attribute boolean elevationRequired;

[src]

/**
   * Whether or not the Update Service can download and install updates.
   * On Windows, this is a function of whether or not the maintenance service
   * is installed and enabled. On other systems, and as a fallback on Windows,
   * this depends on whether the current user has write access to the install
   * directory.
   */

readonly attribute boolean canApplyUpdates;

[src]

/**
   * Whether or not a different instance is handling updates of this
   * installation.  This currently only ever returns true on Windows
   * when 2 instances of an application are open. Only one of the instances
   * will actually handle updates for the installation.
   */

readonly attribute boolean isOtherInstanceHandlingUpdates;

[src]

/**
   * Whether the Update Service is able to stage updates.
   */

readonly attribute boolean canStageUpdates;

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIApplicationUpdateService
[src]

IID: nsIID = nsID(285725191, 41571, 16442, [178, 104, 5, 119, 46, 193, 7, 87])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIApplicationUpdateService
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIApplicationUpdateService
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.