Interface | Description |
---|---|
AsyncService |
An asynchronous version of the REST API Service class,
with callback interfaces instead of blocking methods.
|
AsyncService.AccountCallback |
Defines callback methods for transactions establishing the
customer account context for the API service.
|
AsyncService.DataRetrieveCallback |
Callback interface for GetTransaction.
|
AsyncService.TransactionCallback |
Generic transaction callback interface.
|
Class | Description |
---|---|
AccountTransaction |
Transaction getting account details, filling in a ServiceSpec object.
|
AsyncServiceImpl |
An implementation of the AsyncService interface for Android,
for asynchronous handling of API transactions.
|
DeleteTransaction |
Transaction to delete a resource.
|
Filter |
Represents a data retrieval filter, specifying a filtering
operation on a resource property.
|
GetTransaction |
Transaction to retrieve resource objects from the server.
|
LoginTransaction |
Transaction getting an authentication token based on user name
and password.
|
PostTransaction |
Transaction to create a new resource.
|
PutTransaction |
Transaction to update an existing resource.
|
ResourceItem |
Represents any (id, name) pair, useful for resource
object list entries and other minimal domain objects.
|
ResourceTransaction |
Superclass for REST transactions.
|
Service |
This class represents the REST API service, and an
object of this class is used to perform transactions.
|
ServiceSpec |
Represents a specification of the API Service/Session,
with data about the user and customer entities.
|
Transaction |
Abstract superclass for defining server transactions.
|
Enum | Description |
---|---|
Filter.Operator | |
Resources |
Defines the API resources available.
|
Exception | Description |
---|---|
TransactionException |
Exception thrown when an API transaction fails, for reasons
other than an IOException.
|
A Service or AsyncService object is used to establish a session and execute transactions. All transactions are done within the context of a customer, which is the account entity of the API. A transaction is represented as an object, with classes for GET, POST, PUT and DELETE used to specify transactions for the Service to execute. The available resource types are defined by the Resources enum. Refer to the REST API documentation for documentation of the resource properties.