license: > Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

title: PositionError

PositionError

A PositionError object is returned to the [geolocationError](../parameters/geolocationError.html) callback when an error occurs.

Properties

  • code: One of the predefined error codes listed below.
  • message: Error message describing the details of the error encountered.

Constants

  • PositionError.PERMISSION_DENIED
  • PositionError.POSITION_UNAVAILABLE
  • PositionError.TIMEOUT

Description

The PositionError object is returned to the user through the [geolocationError](../parameters/geolocationError.html) callback function when an error occurs with geolocation.

PositionError.PERMISSION_DENIED

Returned when the user does not allow your application to retrieve position information. This is dependent on the platform.

PositionError.POSITION_UNAVAILABLE

Returned when the device was unable to retrieve a position. In general this means the device has no network connectivity and/or cannot get a satellite fix.

PositionError.TIMEOUT

Returned when the device was unable to retrieve a position within the time specified in the [geolocationOptions](../parameters/geolocation.options.html)' timeout property. When using in conjunction with [geolocation.watchPosition](../geolocation.watchPosition.html), this error could be called into the [geolocationError](../parameters/geolocationError.html) callback every timeout milliseconds.