Package org.vaadin.firitin.geolocation

Class GeolocationOptions

java.lang.Object
org.vaadin.firitin.geolocation.GeolocationOptions
All Implemented Interfaces:
Serializable
@Deprecated(since="3.6", forRemoval=true) public class GeolocationOptions extends Object implements Serializable
Deprecated, for removal: This API element is subject to removal in a future version.
Part of the deprecated Geolocation helper. Use the native com.vaadin.flow.component.geolocation.GeolocationOptions (built via GeolocationOptions.builder()).
A class to configure options for geolocation requests.
Author:
mstahv
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    GeolocationOptions()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    GeolocationOptions(Boolean enableHighAccuracy, Integer timeout, Integer maximumAge)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getEnableHighAccuracy()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The enableHighAccuracy member provides a hint that the application would like to receive the most accurate location data.
    Integer
    getMaximumAge()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Integer
    getTimeout()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The timeout member denotes the maximum length of time, expressed in milliseconds, before acquiring a position expires.
    void
    setEnableHighAccuracy(Boolean enableHighAccuracy)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setMaximumAge(Integer maximumAge)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTimeout(Integer timeout)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • GeolocationOptions

      public GeolocationOptions()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • GeolocationOptions

      public GeolocationOptions(Boolean enableHighAccuracy, Integer timeout, Integer maximumAge)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getEnableHighAccuracy

      public Boolean getEnableHighAccuracy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The enableHighAccuracy member provides a hint that the application would like to receive the most accurate location data. The intended purpose of this member is to allow applications to inform the implementation that they do not require high accuracy geolocation fixes and, therefore, the implementation MAY avoid using geolocation providers that consume a significant amount of power (e.g., GPS).

      NOTE: A word of warning about enableHighAccuracy The enableHighAccuracy member can result in slower response times or increased power consumption. The user might also disable this capability, or the device might not be able to provide more accurate results than if the flag wasn't specified.

      Returns:
      true if high accuracy is requested

    • setEnableHighAccuracy

      public void setEnableHighAccuracy(Boolean enableHighAccuracy)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTimeout

      public Integer getTimeout()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The timeout member denotes the maximum length of time, expressed in milliseconds, before acquiring a position expires.

      NOTE: When is the timeout calculated? The time spent waiting for the document to become visible and for obtaining permission to use the API is not included in the period covered by the timeout member. The timeout member only applies when acquiring a position begins.

      NOTE: Immediate cancellation An options.timeout value 0 can cause immediate failures.

      Returns:
      the timeout

    • setTimeout

      public void setTimeout(Integer timeout)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getMaximumAge

      public Integer getMaximumAge()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      The maximumAge member indicates that the web application is willing to accept a cached position whose age is no greater than the specified time in milliseconds.

    • setMaximumAge

      public void setMaximumAge(Integer maximumAge)
      Deprecated, for removal: This API element is subject to removal in a future version.