Get a previously obtained location again by its location ID.

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

Syntax

C#
public virtual Location GetLocationById(
	User user,
	long locationId,
	Token accessToken,
	LocationOptions options
)
Visual Basic (Declaration)
Public Overridable Function GetLocationById ( _
	user As User, _
	locationId As Long, _
	accessToken As Token, _
	options As LocationOptions _
) As Location
Visual C++
public:
virtual Location^ GetLocationById(
	User^ user, 
	long long locationId, 
	Token^ accessToken, 
	LocationOptions^ options
)

Parameters

user
Type: Veriplace.Client..::.User
the user
locationId
Type: System..::.Int64
the location ID (a value previously obtained from Id.
accessToken
Type: Veriplace.OAuth..::.Token
the access token permitting the user to be located
options
Type: Veriplace.Client..::.LocationOptions
a LocationOptions object which can specify additional information to obtain on the location, and/or a timeout for this request (its LocationMode property has no effect when using this method); null to use defaults

Return Value

the location corresponding to the given ID

Remarks

This requires an access token for permission to locate the user in question. This can be the same access token that you originally used to locate the user, or you can obtain a new one with GetLocationAccessToken(User).

Exceptions

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

See Also