Docs For Class Veriplace_LocationRequestStatus

Description

Holds information about the status of an asynchronous Veriplace_GetLocationAPI request.

since: 1.4

Located in /Veriplace/Types.php (line 773)

Veriplace_AsyncRequestStatus
   |
   --Veriplace_LocationRequestStatus

Variable Summary

Veriplace_Location $location

string $locationId

string $mobileNumber

Veriplace_User $user

Method Summary

Veriplace_LocationRequestStatus __construct ( $id, $user, [ $location = null], [ $locationId = null], [ $exception = null], [ $mobileNumber = null])

Variables

Veriplace_Location $location (line 793)

The requested location, if the request has successfully completed and if the location details were included in the response.

The location details are included if you queried the result with Veriplace_GetLocationAPI::getResult(), or if you used an extended callback - see Veriplace_CallbackOptions. If you used a summary callback, then this property will be null and only the $locationId property will be available.

access: public

string $locationId (line 806)

The unique identifier of the requested location, if the request has successfully completed.

If the location details were not included in the response (i.e. if $getLocation returns null), you can pass the location ID to Veriplace_GetLocationAPI::getLocationById() to retrieve the location details.

access: public

string $mobileNumber (line 820)

The mobile number of the Veriplace user whose location was requested.

This property is provided in callback messages for convenience (in case your callback-processing logic prefers to use mobile numbers rather than Veriplace user IDs), but it is only provided if you used the extended callback format (see Veriplace_CallbackOptions) or if you queried the result with Veriplace_GetLocationAPI::getResult(). If you used a summary callback, then this property will be null.

access: public

Veriplace_User $user (line 779)

The Veriplace user identifier for the user who is being located.

access: public

Inherited Variables

Inherited from Veriplace_AsyncRequestStatus

Veriplace_AsyncRequestStatus::$exception
Veriplace_AsyncRequestStatus::$id
Veriplace_AsyncRequestStatus::$ready

Methods

Constructor __construct (line 822)

access: public

Veriplace_LocationRequestStatus __construct ( $id, $user, [ $location = null], [ $locationId = null], [ $exception = null], [ $mobileNumber = null])

$id
$user
$location
$locationId
$exception
$mobileNumber

Redefinition of:

Veriplace_AsyncRequestStatus::__construct()

Inherited Methods

Inherited From Veriplace_AsyncRequestStatus

Veriplace_AsyncRequestStatus::__construct()