Interface mozIVisitInfoCallbackType

Shared Callback interface for mozIAsyncHistory methods. The semantics for each method are detailed in mozIAsyncHistory.

Hierarchy

Properties

ignoreErrors ignoreResults

Methods

AddRef QueryInterface Release handleCompletion handleError handleResult

Properties

Readonly ignoreErrors

ignoreErrors: bool

Readonly ignoreResults

ignoreResults: bool

These two attributes govern whether we attempt to call handleResult and handleError, respectively, if/once results/errors occur.

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

handleCompletion

  • Called when all records were processed.

    Parameters

    • aUpdatedItems: number

      How many items were successfully updated.

    Returns void

handleError

  • Called when the given place could not be processed.

    Parameters

    • aResultCode: number

      nsresult indicating the failure reason.

    • aPlaceInfo: mozIPlaceInfo

      The information that was given to the caller for the place.

    Returns void

handleResult

  • Called for each place processed successfully.

    Parameters

    • aPlaceInfo: mozIPlaceInfo

      The current info stored for the place.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc