dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Options
PositionOptions Class
An optional object including the following parameters that affect Geolocation.GetCurrentPosition queries
public record PositionOptions : System.IEquatable<dymaptic.GeoBlazor.Core.Options.PositionOptions>
Inheritance System.Object 🡒 PositionOptions
Implements System.IEquatable<PositionOptions>
Constructors
PositionOptions(Nullable, long, long) Constructor
An optional object including the following parameters that affect Geolocation.GetCurrentPosition queries
public PositionOptions(System.Nullable<bool> EnableHighAccuracy, long MaximumAge, long Timeout);
Parameters
EnableHighAccuracy System.Nullable<System.Boolean>
A boolean value 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 device can take the liberty to save resources by responding more quickly and/or using less power. Default: false.
MaximumAge System.Int64
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. Default: 0.
Timeout System.Int64
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.
Properties
PositionOptions.EnableHighAccuracy Property
A boolean value 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 device can take the liberty to save resources by responding more quickly and/or using less power. Default: false.
public System.Nullable<bool> EnableHighAccuracy { get; init; }
Property Value
System.Nullable<System.Boolean>
PositionOptions.MaximumAge Property
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. Default: 0.
public long MaximumAge { get; init; }
Property Value
PositionOptions.Timeout Property
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.
public long Timeout { get; init; }