akasha

Interface PositionOptions.Builder

All Superinterfaces:

PositionOptions

Enclosing interface:

PositionOptions

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public static interface PositionOptions.Builder
extends PositionOptions

The PositionOptions dictionary describes an object containing option properties to pass as a parameter of Geolocation.getCurrentPosition() and Geolocation.watchPosition().

See Also:

PositionOptions - MDN, # position_options_interface

Nested Class Summary

Nested classes/interfaces inherited from interface akasha.PositionOptions

PositionOptions.Builder

Method Summary

Modifier and Type	Method and Description
default PositionOptions.Builder	enableHighAccuracy(boolean enableHighAccuracy) The PositionOptions.enableHighAccuracy property is a Boolean that indicates the application would like to receive the best possible results.
default PositionOptions.Builder	maximumAge(int maximumAge) The PositionOptions.maximumAge property is a positive long value indicating the maximum age in milliseconds of a possible cached position that is acceptable to return.
default PositionOptions.Builder	timeout(int timeout) The PositionOptions.timeout property is a positive long value representing the maximum length of time (in milliseconds) the device is allowed to take in order to return a position.

Methods inherited from interface akasha.PositionOptions

create, enableHighAccuracy, maximumAge, setEnableHighAccuracy, setMaximumAge, setTimeout, timeout

Method Detail

enableHighAccuracy

@JsOverlay
 @Nonnull
default PositionOptions.Builder enableHighAccuracy(boolean enableHighAccuracy)

The PositionOptions.enableHighAccuracy property is a Boolean that indicates the application would like to receive the best possible results. If true and if the device is able to provide a more accurate position, it will do so. Note that this can result in slower response times or increased power consumption (with a GPS chip on a mobile device for example). On the other hand, if false (the default value), the device can take the liberty to save resources by responding more quickly and/or using less power.

See Also:

PositionOptions.enableHighAccuracy - MDN, PositionOptions.enableHighAccuracy - Geolocation API

maximumAge

@JsOverlay
 @Nonnull
default PositionOptions.Builder maximumAge(int maximumAge)

The PositionOptions.maximumAge property is a positive long value indicating the maximum age in milliseconds of a possible cached position that is acceptable to return. If set to 0, it means that the device cannot use a cached position and must attempt to retrieve the real current position. If set to Infinity the device must return a cached position regardless of its age.

See Also:

PositionOptions.maximumAge - MDN, PositionOptions.maximumAge - Geolocation API

timeout

@JsOverlay
 @Nonnull
default PositionOptions.Builder timeout(int timeout)

The PositionOptions.timeout property is a positive long value representing the maximum length of time (in milliseconds) the device is allowed to take in order to return a position. The default value is Infinity, meaning that getCurrentPosition() won't return until the position is available.

See Also:

PositionOptions.timeout - MDN, PositionOptions.timeout - Geolocation API