Submit an asynchronous request for a user's location, with options
for extended callback behavior.
Namespace:
Veriplace.ClientAssembly: Veriplace.Client (in Veriplace.Client.dll) Version: 1.7.0.25986 (1.7.0.0)
Syntax
| C# |
|---|
public LocationRequestStatus RequestLocation( User user, Token accessToken, LocationOptions locationOptions, CallbackOptions callbackOptions ) |
| Visual Basic (Declaration) |
|---|
Public Function RequestLocation ( _ user As User, _ accessToken As Token, _ locationOptions As LocationOptions, _ callbackOptions As CallbackOptions _ ) As LocationRequestStatus |
| Visual C++ |
|---|
public: LocationRequestStatus^ RequestLocation( User^ user, Token^ accessToken, LocationOptions^ locationOptions, CallbackOptions^ callbackOptions ) |
Parameters
- user
- Type: Veriplace.Client..::.User
the user
- accessToken
- Type: Veriplace.OAuth..::.Token
the access token permitting the user to be located
- locationOptions
- Type: Veriplace.Client..::.LocationOptions
a LocationOptions object allowing the location mode and other properties to be overridden for this request; null to use defaults
- callbackOptions
- Type: Veriplace.Client..::.CallbackOptions
an optional CallbackOptions object specifying how Veriplace should post the result back to you when ready; null if you will poll for the result
Return Value
a LocationRequestStatus that uniquely identifies the request
Remarks
This version of the method takes a CallbackOptions
parameter, which, if not null, can specify both a callback URI for
receiving the result of the request and additional options for the
format of the result message. You can process the callback message
with GetCallbackResult(HttpRequest, HttpResponse). If you don't specify a
callback, use GetResult(LocationRequestStatus) to poll for the result.
Exceptions
| Exception | Condition |
|---|---|
| Veriplace.Client..::.GetLocationNotPermittedException | if the server refused the location request |
| Veriplace.Client..::.UnexpectedException | if there was an unexpected I/O error or OAuth error |