carp_services/carp_services library
Classes
- ActiveParticipationInvitationDialog
-
A modal dialog shown a list of
ActiveParticipationInvitationfor the user to select one from. - AuthenticationDialog
- A modal dialog shown to the user to input username and password.
- CANSProtocolService
-
A
ProtocolServicethat talks to the CARP Nervous System (CANS), i.e., the CARP backend server(s). - CarpApp
- Represents a CARP web service app endpoint.
- CarpAuthenticationForm
- CarpBaseService
- An abstract base service class for all CARP Services:
- CarpDeploymentService
-
A
DeploymentServicethat talks to the CARP backend server(s). - CARPEmailValidator
- CarpFileResponse
- A file object as retrieved from the CARP server.
- CarpParticipationService
-
A
ParticipationServicethat talks to the CARP backend server(s). - CarpReference
- Abstract CARP web service references.
- CarpService
- Provide access to a CARP web service 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
-
Provides a reference to the deployment endpoint in a CARP web service that can
handle a specific
MasterDeviceDeployment. - 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
- MultipartFileRecreatable
- A MultipartFile class which support cloning of the file for re-submission of POST request.
- ParticipationReference
- Provide a participation endpoint reference to a CARP web service.
- PushIdGenerator
- Utility class for generating CARP document keys.
- RPCCarpReference
Enums
- AuthEvent
- Authentication state change events.
- TaskStateType
Exceptions / Errors
- CarpServiceException
- Exception for CARP REST/HTTP service communication.