Interface nsIGeolocationUpdateType

Interface provides a way for a geolocation provider to notify the system that a new location is available.

Hierarchy

Methods

AddRef QueryInterface Release notifyError update

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

notifyError

  • Notify the geolocation service of an error. This must be called on the main thread. The parameter refers to one of the constants in the nsIDOMGeoPositionError interface. Use this to report spurious errors coming from the provider; for errors occurring inside the methods in the nsIGeolocationProvider interface, just use the return value.

    Parameters

    • error: number

    Returns void

update

  • Notify the geolocation service that a new geolocation has been discovered. This must be called on the main thread

    Parameters

    • position: nsIDOMGeoPosition

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc