Class Veriplace_InvitationStatus

Description

Holds information about the status of a Veriplace_InvitationAPI request.

  • since: 1.3

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

Veriplace_AsyncRequestStatus
   |
   --Veriplace_InvitationStatus
Variable Summary
Method Summary
 Veriplace_InvitationStatus __construct ( $id,  $mobileNumber,  $user,  $exception, [ $accessToken = null])
Variables
mixed $accessToken (line 868)

The access token for the user who granted permission to the application, if the request was successfully completed.

The access token is included if you queried the result with Veriplace_InvitationAPI::getResult(), or if you used an extended callback - see Veriplace_CallbackOptions. If you used a summary callback, then this property will be null and you will need to use getLocationAccessToken() to get the token.

  • access: public
string $mobileNumber (line 848)

The mobile number to which the invitation was sent.

The mobile number is included in a callback result only if you used an extended callback - see Veriplace_CallbackOptions; if you used a summary callback, then this property will be null.

  • access: public
Veriplace_User $user (line 856)

The Veriplace user identifier for the user who granted permission to the application, if the request was successfully completed; null if the request has failed or is still in progress.

  • access: public

Inherited Variables

Inherited from Veriplace_AsyncRequestStatus

Veriplace_AsyncRequestStatus::$exception
Veriplace_AsyncRequestStatus::$id
Veriplace_AsyncRequestStatus::$ready
Methods
Constructor __construct (line 870)
  • access: public
Veriplace_InvitationStatus __construct ( $id,  $mobileNumber,  $user,  $exception, [ $accessToken = null])
  • $id
  • $mobileNumber
  • $user
  • $exception
  • $accessToken

Redefinition of:
Veriplace_AsyncRequestStatus::__construct()

Inherited Methods

Inherited From Veriplace_AsyncRequestStatus

 Veriplace_AsyncRequestStatus::__construct()

Documentation generated on Sun, 29 Aug 2010 04:08:39 -0700 by phpDocumentor 1.4.1