Overview   Package  Class  Tree  Deprecated  Index  Help 
 PREV PACKAGE   NEXT PACKAGE FRAMES    NO FRAMES    

Package com.veriplace.client

Provides primary Client interface to Veriplace Developer APIs.

See:
          Description

Interface Summary
LocationFilter Interface for an object that can apply post-processing to returned locations.
 

Class Summary
AsyncCapableAPI<TRequestStatus extends AsyncRequestStatus> Base class for Veriplace APIs that deliver an asynchronous response.
AsyncRequestStatus Base class for asynchronous requests created by a subclass of AsyncCapableAPI.
CallbackOptions Specifies optional parameters for an asynchronous request whose result will be delivered by HTTP callback.
Client Veriplace client implementation in Java.
ClientConfiguration Encapsulates the various properties that can be configured for a Veriplace Client.
DefaultLocationFilter Default implementation of LocationFilter.
GetLocationAPI Interface for obtaining a user's location from Veriplace.
InvitationAPI Interface for initiating an SMS invitation from Veriplace to an end user, allowing the user to opt into this application.
InvitationStatus Holds information about the status of an InvitationAPI request.
Location Representation of the location of a Veriplace user.
LocationMode Constants representing the allowable location modes.
LocationOptions Specifies optional parameters for a location request.
LocationRequestStatus Holds information about the status of an asynchronous GetLocationAPI request.
LocationUpdateReference Opaque representation of a location update identifier for PollingAPI.
LocationUpdates A result set returned by PollingAPI.getUpdates(Integer), representing location updates that occurred within a given time interval whose details can be queried by the current application.
PermissionAPI Interface for verifying or removing an application's permissions for specific resources in the Veriplace platform.
PointOfInterest Describes a geographic point of interest, such as a business or a landmark.
PollingAPI Interface for querying user location changes in bulk, using a version of the Simple Update Protocol.
Position Base class for objects that describe a geographic location.
PositionReference<T extends Position> Describes a geographic relationship to some Position.
StreetIntersection Describes an intersection of two streets.
User Representation of a Veriplace user.
UserDiscoveryAPI Interface for obtaining user identity information from Veriplace.
UserDiscoveryParameters Encapsulates the various ways in which you can attempt to find a user with UserDiscoveryAPI.getUserByParameters(UserDiscoveryParameters).
 

Enum Summary
LocationOptions.ExtraInfo Enumeration of extended location data structures that can be requested.
 

Exception Summary
BadParameterException Thrown to indicate that our request to the Veriplace server had invalid parameters.
ConfigurationException Thrown to indicate that a Veriplace configuration property is invalid.
GetLocationBillingDeclinedException Thrown to indicate that a GetLocationAPI method failed because the billing system did not approve the request for this application.
GetLocationException Base class for exceptions in GetLocationAPI methods.
GetLocationNotPermittedException Thrown to indicate that a GetLocationAPI method failed because the application does not have permission to locate the user.
InvalidCallbackException A callback did not contain an oauth_token parameter or contained one that does not match any known request token.
InvitationDeclinedException Thrown to indicate that an InvitationAPI method failed because the user refused the permission request.
InvitationException Base class for exceptions in InvitationAPI methods.
InvitationNotPermittedException Thrown to indicate that an InvitationAPI method failed because the application does not have permission to identify the user.
MalformedResponseException Thrown to indicate that the Veriplace server returned a response that the client could not understand.
PositionFailureException Thrown to indicate that a GetLocationAPI method failed because Veriplace could not obtain the user's location, although your request was valid.
RequestDeniedException Base class for exceptions that indicate a known failure mode of a specific API request.
RequestNotFoundException Indicates that an asynchronous request ID was no longer valid.
TransportException Wrapper for a low-level I/O exception when it occurs within a Veriplace client method.
UnexpectedException Base class for all exceptions that do not represent a normal failure mode.
UnknownTokenException  
UserDiscoveryException Base class for exceptions in UserDiscoveryAPI methods.
UserDiscoveryNotPermittedException Thrown to indicate that a UserDiscoveryAPI method failed because the application does not have permission to identify the user.
UserNotFoundException Thrown to indicate that a UserDiscoveryAPI method failed because Veriplace could not identify the user.
VeriplaceException Base class for all exceptions that can be thrown by the Veriplace client, other than I/O exceptions.
VeriplaceOAuthException Wrapper for an OAuthException when it is thrown from within a Veriplace client method.
 

Package com.veriplace.client Description

Provides primary Client interface to Veriplace Developer APIs. The Veriplace Developer APIs use the OAuth protocol for secure authentication and authorization; users of the Client interface are encouraged to familiarize themselves with OAuth.

Usage

Developers must register with Veriplace to obtain credentials, including: The Client class is the primary interface and should be constructed with these credentials. Developers may also configure how the Client manages OAuth Request Tokens by providing an instance of TokenStore. 
  Client client = new Client(consumerKey, consumerSecret, token, baseUrl, tokenStore);
Users may prefer to employ the DefaultClientFactory to create Client instances.

APIs

A Client instance provides programmatic access to each of the Veriplace APIs, including:

Overview   Package  Class  Tree  Deprecated  Index  Help 
 PREV PACKAGE   NEXT PACKAGE FRAMES    NO FRAMES