Invite a user to grant Get Location permission to this application, by sending a message to the user's mobile device.

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

Syntax

C#
public InvitationStatus InviteGetLocation(
	string mobileNumber,
	bool sendUserConfirmation,
	CallbackOptions callbackOptions
)
Visual Basic (Declaration)
Public Function InviteGetLocation ( _
	mobileNumber As String, _
	sendUserConfirmation As Boolean, _
	callbackOptions As CallbackOptions _
) As InvitationStatus
Visual C++
public:
InvitationStatus^ InviteGetLocation(
	String^ mobileNumber, 
	bool sendUserConfirmation, 
	CallbackOptions^ callbackOptions
)

Parameters

mobileNumber
Type: System..::.String
the mobile number of the user to be invited; see UserDiscoveryParameters for acceptable mobile number formats
sendUserConfirmation
Type: System..::.Boolean
true if Veriplace should send the user a final SMS after the user accepts or declines the invitation, to confirm the result; false to skip that step (pass false only if your application has some other mechanism for notifying the user on completion)
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

an InvitationStatus object which contains either a unique identifier for the request, or else a user identifier if the request was unnecessary; in the latter case, Completed will be true and you will not receive a callback

Remarks

If allowable - and if the application doesn't already have permission - the user will receive a text message from Veriplace with options to accept or decline the invitation, and to register with Veriplace if the user wasn't already registered.

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(InvitationStatus) to poll for the result.

Note that if an application is in development and has not yet been published, it can only invite developer-mode users (i.e. the numbers on its Test Phones list).

To use this method, you must have configured the client with an application-specific access token.

See Also