Retrieves information about a specific location update.
Namespace:
Veriplace.ClientAssembly: Veriplace.Client (in Veriplace.Client.dll) Version: 1.7.0.25986 (1.7.0.0)
Syntax
| C# |
|---|
public virtual Location GetUpdateLocation( LocationUpdateReference update, Token accessToken, Nullable<int> timeoutMilliseconds ) |
| Visual Basic (Declaration) |
|---|
Public Overridable Function GetUpdateLocation ( _ update As LocationUpdateReference, _ accessToken As Token, _ timeoutMilliseconds As Nullable(Of Integer) _ ) As Location |
| Visual C++ |
|---|
public: virtual Location^ GetUpdateLocation( LocationUpdateReference^ update, Token^ accessToken, Nullable<int> timeoutMilliseconds ) |
Parameters
- update
- Type: Veriplace.Client..::.LocationUpdateReference
a LocationUpdateReference object returned by a previous call to GetUpdates(Nullable<(Of <(Int32>)>))
- accessToken
- Type: Veriplace.OAuth..::.Token
an access token permitting the user to be located
- timeoutMilliseconds
- Type: System..::.Nullable<(Of <(Int32>)>)
the maximum number of milliseconds to wait, or null for no timeout
Return Value
the location data
Exceptions
| Exception | Condition |
|---|---|
| Veriplace.Client..::.PositionFailureException | if the result of this location update was an error |
| Veriplace.Client..::.GetLocationNotPermittedException | if the access token does not allow getting locations for this user |
| Veriplace.Client..::.UnexpectedException | if there was an unexpected OAuth error or I/O error |