PositionOptions (Akasha Java Browser API)

```
@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public interface 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, PositionOptions - Geolocation API

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static PositionOptions`	`create()`
`boolean`	`enableHighAccuracy()` The PositionOptions.enableHighAccuracy property is a Boolean that indicates the application would like to receive the best possible results.
`default PositionOptions`	`enableHighAccuracy(boolean enableHighAccuracy)` The PositionOptions.enableHighAccuracy property is a Boolean that indicates the application would like to receive the best possible results.
`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`	`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.
`void`	`setEnableHighAccuracy(boolean enableHighAccuracy)` The PositionOptions.enableHighAccuracy property is a Boolean that indicates the application would like to receive the best possible results.
`void`	`setMaximumAge(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.
`void`	`setTimeout(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.
`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.
`default PositionOptions`	`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.

- Method Detail
  - create
```
@JsOverlay
 @Nonnull
static PositionOptions create()
```
  - enableHighAccuracy
```
@JsProperty(name="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
  - setEnableHighAccuracy
```
@JsProperty
void setEnableHighAccuracy(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
  - enableHighAccuracy
```
@JsOverlay
 @Nonnull
default PositionOptions 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
```
@JsProperty(name="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
  - setMaximumAge
```
@JsProperty
void setMaximumAge(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
  - maximumAge
```
@JsOverlay
 @Nonnull
default PositionOptions 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
```
@JsProperty(name="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
  - setTimeout
```
@JsProperty
void setTimeout(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
  - timeout
```
@JsOverlay
 @Nonnull
default PositionOptions 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

Interface PositionOptions

Method Summary

Method Detail

create

enableHighAccuracy

setEnableHighAccuracy

enableHighAccuracy

maximumAge

setMaximumAge

maximumAge

timeout

setTimeout

timeout