Class Veriplace_PollingAPI

Description
Description | Vars (details) | Methods (details)

Interface for querying user location changes in bulk, using a version of the Simple Update Protocol.

See Veriplace Developer Guide: Using the Polling API for more details.

  • since: 1.3

Located in /Veriplace/Client.php (line 1685) 

Veriplace_API
   |
   --Veriplace_PollingAPI
Variable Summary
Description | Vars (details) | Methods (details)
int $periodSeconds
Method Summary
Description | Vars (details) | Methods (details)
Veriplace_Location getUpdateLocation (string $updateId, Veriplace_Token $accessToken, [int $timeout = null])
Veriplace_LocationUpdates getUpdates ([int $timeout = null])
Variables
Description | Vars (details) | Methods (details)
int $periodSeconds (line 1695)

The interval, in seconds, between updates to the location update list.

If zero or negative, the Veriplace server will use its default interval (60 seconds).

  • access: public
Methods
Description | Vars (details) Methods (details)
getUpdateLocation (line 1739)

Retrieves information about a specific location update.

  • return: the location data
  • throws: Veriplace_PositionFailureException if the result of this location update was an error
  • throws: Veriplace_GetLocationNotPermittedException if the access token does not allow getting locations for this user
  • throws: Veriplace_UnexpectedException if there was an unexpected I/O error or OAuth error
  • access: public
Veriplace_Location getUpdateLocation (string $updateId, Veriplace_Token $accessToken, [int $timeout = null])
  • string $updateId: An update identifier returned by a previous call to Veriplace_PollingAPI::getUpdates().
  • Veriplace_Token $accessToken: An access token permitting the user to be located.
  • int $timeout: Deprecated and ignored, but retained for backward compatibility. Timeout should not be specified for this request.
getUpdates (line 1711)

Retrieves information about recent location updates for all users that this application can locate.

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

  • return: a Veriplace_LocationUpdates object containing the query results
  • throws: Veriplace_UnexpectedException if there was an unexpected I/O error or OAuth error
  • access: public
Veriplace_LocationUpdates getUpdates ([int $timeout = null])
  • int $timeout: Deprecated and ignored, but retained for backward compatibility. Timeout should not be specified for this request.

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