Struct xpcom::interfaces::nsIQuotaManagerService [] [src]

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

interface nsIQuotaManagerService : nsISupports

Methods

impl nsIQuotaManagerService
[src]

[src]

Cast this nsIQuotaManagerService to one of its base interfaces.

impl nsIQuotaManagerService
[src]

[src]

/**
   * Initializes storage directory. This can be used in tests to verify
   * upgrade methods.
   *
   * If the dom.quotaManager.testing preference is not true the call will be
   * a no-op.
   */

[must_use] nsIQuotaRequest init ();

[src]

/**
   * Initializes storages for the given principal. This can be used in tests to
   * verify origin initialization.
   *
   * If the dom.quotaManager.testing preference is not true the call will be
   * a no-op.
   *
   * @param aPrincipal
   *        A principal for the origin whose storages are to be initialized.
   * @param aPersistenceType
   *        A string that tells what persistence type of storages will be
   *        initialized.
   */

[must_use] nsIQuotaRequest initStoragesForPrincipal (in nsIPrincipal aPrincipal, in ACString aPersistenceType);

[src]

/**
   * Schedules an asynchronous callback that will inspect all origins and
   * return the total amount of disk space being used by storages for each
   * origin separately.
   *
   * @param aCallback
   *        The callback that will be called when the usage is available.
   * @param aGetAll
   *        An optional boolean to indicate inspection of all origins,
   *        including internal ones.
   */

[must_use] nsIQuotaUsageRequest getUsage (in nsIQuotaUsageCallback aCallback, [optional] in boolean aGetAll);

[src]

/**
   * Schedules an asynchronous callback that will return the total amount of
   * disk space being used by storages for the given origin.
   *
   * @param aPrincipal
   *        A principal for the origin whose usage is being queried.
   * @param aCallback
   *        The callback that will be called when the usage is available.
   * @param aGetGroupUsage
   *        An optional flag to indicate whether getting group usage and limit
   *        or origin usage and file usage. The default value is false.
   * Note:  Origin usage here represents total usage of an origin. However,
   *        group usage here represents only non-persistent usage of a group.
   */

[must_use] nsIQuotaUsageRequest getUsageForPrincipal (in nsIPrincipal aPrincipal, in nsIQuotaUsageCallback aCallback, [optional] in boolean aGetGroupUsage);

[src]

/**
   * Removes all storages. The files may not be deleted immediately depending
   * on prohibitive concurrent operations.
   * Be careful, this removes *all* the data that has ever been stored!
   *
   * If the dom.quotaManager.testing preference is not true the call will be
   * a no-op.
   */

[must_use] nsIQuotaRequest clear ();

[src]

/**
   * Removes all storages stored for the given principal. The files may not be
   * deleted immediately depending on prohibitive concurrent operations.
   *
   * @param aPrincipal
   *        A principal for the origin whose storages are to be cleared.
   * @param aPersistenceType
   *        An optional string that tells what persistence type of storages
   *        will be cleared.
   * @param aClearAll
   *        An optional boolean to indicate clearing all storages under the
   *        given origin.
   */

[must_use] nsIQuotaRequest clearStoragesForPrincipal (in nsIPrincipal aPrincipal, [optional] in ACString aPersistenceType, [optional] in boolean aClearAll);

[src]

/**
   * Resets quota and storage management. This can be used to force
   * reinitialization of the temp storage, for example when the pref for
   * overriding the temp storage limit has changed.
   * Be carefull, this invalidates all live storages!
   *
   * If the dom.quotaManager.testing preference is not true the call will be
   * a no-op.
   */

[must_use] nsIQuotaRequest reset ();

[src]

/**
   * Check if given origin is persisted.
   *
   * @param aPrincipal
   *        A principal for the origin which we want to check.
   */

[must_use] nsIQuotaRequest persisted (in nsIPrincipal aPrincipal);

[src]

/**
   * Persist given origin.
   *
   * @param aPrincipal
   *        A principal for the origin which we want to persist.
   */

[must_use] nsIQuotaRequest persist (in nsIPrincipal aPrincipal);

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 nsIQuotaManagerService
[src]

IID: nsIID = nsID(456985144, 33105, 19705, [137, 250, 79, 146, 194, 239, 14, 126])

[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 nsIQuotaManagerService
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIQuotaManagerService
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.