Package com.yoti.api.client.shareurl.extension

Class LocationConstraintExtensionBuilder

java.lang.Object

com.yoti.api.client.shareurl.extension.LocationConstraintExtensionBuilder

All Implemented Interfaces:

ExtensionBuilder<LocationConstraintContent>

public class LocationConstraintExtensionBuilder
extends Object
implements ExtensionBuilder<LocationConstraintContent>

Constructor Summary

Constructors

Constructor	Description
LocationConstraintExtensionBuilder()

Method Summary

Modifier and Type	Method	Description
Extension<LocationConstraintContent>	build()
LocationConstraintExtensionBuilder	withLatitude(double latitude)	Allows you to specify the Latitude of the user's expected location
LocationConstraintExtensionBuilder	withLongitude(double longitude)	Allows you to specify the Longitude of the user's expected location
LocationConstraintExtensionBuilder	withMaxUncertainty(double maxUncertainty)	Maximum acceptable distance, in metres, of the area of uncertainty associated with the device location coordinates If not provided, a default value of 150m will be used.
LocationConstraintExtensionBuilder	withRadius(double radius)	Radius of the circle, centred on the specified location coordinates, where the device is allowed to perform the share If not provided, a default value of 150m will be used.

Methods inherited from class java.lang.Object

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

Constructor Details

LocationConstraintExtensionBuilder

public LocationConstraintExtensionBuilder()

Method Details

withLatitude

public LocationConstraintExtensionBuilder withLatitude(double latitude)

Allows you to specify the Latitude of the user's expected location

Returns:

this LocationConstraintExtensionBuilder

withLongitude

public LocationConstraintExtensionBuilder withLongitude(double longitude)

Allows you to specify the Longitude of the user's expected location

Returns:

this LocationConstraintExtensionBuilder

withRadius

public LocationConstraintExtensionBuilder withRadius(double radius)

Radius of the circle, centred on the specified location coordinates, where the device is allowed to perform the share If not provided, a default value of 150m will be used.

Parameters:

radius - The allowable distance, in metres, from the given lat/long location

Returns:

this LocationConstraintExtensionBuilder

withMaxUncertainty

public LocationConstraintExtensionBuilder withMaxUncertainty(double maxUncertainty)

Maximum acceptable distance, in metres, of the area of uncertainty associated with the device location coordinates If not provided, a default value of 150m will be used.

Parameters:

maxUncertainty - Maximum allowed measurement uncertainty, in metres

Returns:

this LocationConstraintExtensionBuilder

build

public Extension<LocationConstraintContent> build()

Specified by:

build in interface ExtensionBuilder<LocationConstraintContent>

Returns:

An object, T, built with parameters of this builder