Submit an asynchronous request for a user's location.

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

Syntax

C#
public LocationRequestStatus RequestLocation(
	User user,
	Token accessToken,
	string callback,
	LocationOptions options
)
Visual Basic (Declaration)
Public Function RequestLocation ( _
	user As User, _
	accessToken As Token, _
	callback As String, _
	options As LocationOptions _
) As LocationRequestStatus
Visual C++
public:
LocationRequestStatus^ RequestLocation(
	User^ user, 
	Token^ accessToken, 
	String^ callback, 
	LocationOptions^ options
)

Parameters

user
Type: Veriplace.Client..::.User
the user
accessToken
Type: Veriplace.OAuth..::.Token
the access token permitting the user to be located
callback
Type: System..::.String
a callback URI to which Veriplace should post the result when it is ready, or null if you will poll for the result
options
Type: Veriplace.Client..::.LocationOptions
a LocationOptions object allowing the location mode and other properties to be overridden for this request; null to use defaults

Return Value

a LocationRequestStatus that uniquely identifies the request

Remarks

You may poll for the result with GetResult(LocationRequestStatus), or specify a callback URI, in which case Veriplace will send an HTTP POST message to that URI when the result is ready; you can process the callback message with GetCallbackResult(HttpRequest, HttpResponse). This version generates only a summary message in the callback; to get the full result by callback, use RequestLocation(User, Token, String, LocationOptions).

Exceptions

ExceptionCondition
Veriplace.Client..::.GetLocationNotPermittedExceptionif the server refused the location request
Veriplace.Client..::.UnexpectedExceptionif there was an unexpected I/O error or OAuth error

See Also