Specifies optional parameters for a location request.

These can include the following:

• A Veriplace_LocationMode name.
• A Veriplace_LocationFilter 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 Veriplace_TransportException. This has no effect on asynchronous requests.

LocationOptions may be configured globally for the application in the client configuration; some of these can also be set in a properties file using property names defined by Veriplace_DefaultClientFactory. For any given Veriplace_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.

• property: string $mode: The selected Veriplace_LocationMode name, if any, or null.
• property: Veriplace_LocationFilter $filter: The selected Veriplace_LocationFilter, if any, or null.
• property: int $extraInfo: The selected extra location data types, if any, or null. This value is a bit mask that can include either or both of the constants Veriplace_LocationOptions::NearestPointOfInterest and Veriplace_LocationOptions::NearestStreetIntersection.
• property: int $timeoutMilliseconds: The selected timeout interval, if any, or null.
• property: boolean $suppressCachedPosition: True if Veriplace should not include cached position in a Veriplace_PositionFailureException. By default, it will include cached position if available.
• see: Veriplace_GetLocationAPI::requestLocation()
• see: Veriplace_GetLocationAPI::getLocationById()
• see: Veriplace_GetLocationAPI::getLocation()

Located in /Veriplace/Types.php (line 414)