carp_services/carp_services library

A library for all CARP Web Services (CAWS):

The (current) assumption is that each Flutter app (using this library) will only connect to one CAWS backend. All CAWS services are therefore singletons and can be used like:

await CarpAuthService().configure(authProperties);

user = await CarpAuthService().authenticateWithUsernamePassword(
  username: username,
  password: password,
);

CarpParticipationService().configure(app);

where authProperties, username, and password are parameters for setting up authentication, and app is configuring the participation service to use the right CAWS instance.

Classes

ActiveParticipationInvitationDialog: A modal dialog shown a list of ActiveParticipationInvitation for the user to select one from.
CarpApp: Represents a CARP web service app endpoint.
CarpBaseService: An abstract base service class for all CARP Services:
CarpDataStreamService: A DataStreamService that talks to the CARP Web Services.
CarpDeploymentService: A DeploymentService that talks to the CARP Web Services.
CarpFileResponse: A file object as retrieved from the CARP server.
CarpParticipationService: A ParticipationService that talks to the CARP backend server(s).
CarpProtocolService: A ProtocolService that talks to the CARP Web Services.
CarpReference: Abstract CARP web service references.
CarpService: Provide access to a CARP Web Services (CAWS) endpoints.
CarpServiceTask
ClonableMultipartFile: A MultipartFile class which support cloning of the file for re-submission of POST request.
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
DataPoint: A data point storing meta-information and the data.
DataPointHeader: The header (meta-data) attached to all DataPoints.
DataPointReference: Provide a data endpoint reference to a CARP Web Service.
DataStreamReference: Provides a reference to the data stream endpoint in a CARP web service.
DeploymentReference: Provides a reference to the deployment endpoint in a CARP web service that can handle a specific PrimaryDeviceDeployment.
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
ParticipationReference: Provide a participation endpoint reference to a CARP web service.
PushIdGenerator: Utility class for generating CARP document keys.
RPCCarpReference

Enums

TaskStateType

Properties

httpr → HTTPRetry: The HTTP Retry method.
final

Functions

zipJson(Map<String, dynamic> json) → List<int>: Zip the json JSON to a list of bytes.
zipString(String str) → List<int>: Zip the str string to a list of bytes using UTF8 encoding.

Exceptions / Errors

CarpServiceException: Exception for CAWS REST/HTTP service communication.