Interface mozIAsyncHistoryType

This interface contains APIs for cpp consumers. Javascript consumers should look at History.jsm instead, that is exposed through PlacesUtils.history.

If you're evaluating adding a new history API, it should usually go to History.jsm, unless it needs to do long and expensive work in a batch, then it could be worth doing that in History.cpp.

Hierarchy

Methods

AddRef QueryInterface Release isURIVisited updatePlaces

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

isURIVisited

  • Checks if a given URI has been visited.

    Parameters

    • aURI: nsIURI

      The URI to check for.

    • aCallback: mozIVisitedStatusCallback

      A mozIVisitStatusCallback object which receives the visited status.

    Returns void

updatePlaces

  • Adds a set of visits for one or more mozIPlaceInfo objects, and updates each mozIPlaceInfo's title or guid.

    aCallback.handleResult is called for each visit added.

    Throws

    NS_ERROR_INVALID_ARG

    • Passing in NULL for aPlaceInfo.
    • Not providing at least one valid guid, or uri for all mozIPlaceInfo object[s].
    • Not providing an array or nothing for the visits property of mozIPlaceInfo.
    • Not providing a visitDate and transitionType for each mozIVisitInfo.
    • Providing an invalid transitionType for a mozIVisitInfo.

    Parameters

    • aPlaceInfo: any

      The mozIPlaceInfo object[s] containing the information to store or update. This can be a single object, or an array of objects.

    • aCallback: mozIVisitInfoCallback

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc