Interface nsIGeolocationProviderType

Interface provides location information to the nsGeolocator via the nsIDOMGeolocationCallback interface. After startup is called, any geo location change should call callback.update().

Hierarchy

Methods

AddRef QueryInterface Release setHighAccuracy shutdown startup watch

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

setHighAccuracy

  • hint to provide to use any amount of power to provide a better result

    Parameters

    • enable: boolean

    Returns void

shutdown

  • shutdown Shuts down the location device.

    Returns void

startup

  • Start up the provider. This is called before any other method. may be called multiple times.

    Returns void

watch

  • watch When a location change is observed, notify the callback.

    Parameters

    • callback: nsIGeolocationUpdate

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc