Specifies optional parameters for a location request.

Namespace:  Veriplace.Client
Assembly:  Veriplace.Client (in Veriplace.Client.dll) Version: 1.7.0.25986 (1.7.0.0)

Syntax

C#
public class LocationOptions : ICloneable
Visual Basic (Declaration)
Public Class LocationOptions _
	Implements ICloneable
Visual C++
public ref class LocationOptions : ICloneable

Remarks

These can include the following:

  • A LocationMode name.
  • An ILocationFilter which will be applied to all returned locations or position errors.
  • Flags for optional extended location data.
  • A timeout interval. If a location request does not complete within this time limit, it will throw a TransportException. This has no effect on asynchronous requests.

LocationOptions may be configured globally for the application in the client (see LocationOptions); some of these can also be set in a properties file using property names defined by DefaultClientFactory. For any given GetLocationAPI request that takes a LocationOptions reference, if that reference is null or if one of the object's properties has not been set, the corresponding property from the global configuration will be used instead.

Inheritance Hierarchy

System..::.Object
  Veriplace.Client..::.LocationOptions

See Also