carp_services library

Classes

CarpApp
Represents a CARP web service app endpoint.
CARPDataPoint
A CARP Data Point which can be up/downloaded to/from the CARP Web Services API. [...]
CARPDataPointHeader
The header attached to all CARPDataPoints.
CarpFileResponse
Represents the response from the CARP server when getting file objects.
CarpReference
Abstract CARP web service references.
CarpService
Provide access to the CARP web services endpoint. [...]
CarpServiceTask
CollectionReference
Provide a collection reference to a CARP web service. [...]
ConsentDocument
A ConsentDocument contains data read from a consent document in the CARP web service [...]
DataPointReference
Provide a data endpoint reference to a CARP web service. Used to: [...]
DeploymentReference
Provide a deployment endpoint reference to a CARP web service. [...]
DocumentReference
A DocumentReference refers to a document in a CARP collection and can be used to write, read, or delete this document. [...]
DocumentSnapshot
A DocumentSnapshot contains data read from a collection in the CARP web service [...]
FileDownloadTask
A task supporting asynchronous download of a file.
FileMetadata
Metadata for a FileStorageReference. Metadata stores default attributes such as size and content type. Also allow for storing custom metadata.
FileStorageReference
Provide a file endpoint reference to a CARP web service. Used to: [...]
FileUploadTask
A task supporting asynchronous upload of a file.
HTTPRetry
A class wrapping all HTTP operations (GET, POST, PUT, DELETE) in a retry manner. [...]
HTTPStatus
Implements HTTP Response Code and associated Reason Phrase. See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
PushIdGenerator
Utility class for generating CARP document keys. [...]

Properties

httpr HTTPRetry
The HTTP Retry method.
final

Enums

TaskStateType

Exceptions / Errors

CarpServiceException
Exception for CARP REST/HTTP service communication.