CarpService class

Provide access to a CARP Web Services (CAWS) endpoints.

This provides access to the 'non-core' CAWS endpoints:

  • Files
  • Documents and Collections
  • Informed Consent (deprecated)
  • Data Points (deprecated)

CARP Core web services are access via the specialized services, like DeploymentService, ProtocolService, ParticipationService, and DataStreamService.

Inheritance

Constructors

CarpService()
Returns the singleton default instance of the CarpService. Before this instance can be used, it must be configured using the configure method.
factory
CarpService.instance()

Properties

app → CarpApp
The CARP app associated with the CARP Web Service.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, String>
The headers for any authenticated HTTP REST call to a CarpBaseService.
no setterinherited
isConfigured → bool
Has this service been configured?
no setterinherited
rpcEndpointName → String
The endpoint name for this service at CARP.
no setteroverride
rpcEndpointUri → String
The URL for this service's endpoint at CARP.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
study ↔ SmartphoneStudy?
The study associated with this service, if available. Can be set directly or as part of the configure methods.
getter/setter pairinherited

Methods

collection(String path, {String? studyId}) → CollectionReference
Gets a CollectionReference for the path.
configure(CarpApp app, [SmartphoneStudy? study]) → void
Configure the this instance of a Carp Service.
inherited
configureFrom(CarpBaseService service) → void
Configure from another service which has already been configured.
inherited
createConsentDocument(Map<String, dynamic> document, {String? studyDeploymentId}) → Future<ConsentDocument>
Create a new (signed) consent document. Returns the created ConsentDocument if the document is uploaded correctly.
dataPointReference([String? studyDeploymentId]) → DataPointReference
Creates a new DataPointReference initialized at the current CarpService storage location.
document(String path, {String? studyId}) → DocumentReference
Gets a DocumentReference for the specified path.
documentById(int id, {String? studyId}) → DocumentReference
Gets a DocumentReference for the specified unique id for study with id studyId.
documents([String? studyId]) → Future<List<DocumentSnapshot>>
Get all documents for a study.
documentsByQuery(String query, {String? studyId}) → Future<List<DocumentSnapshot>>
Get a list documents based on a query.
getAllFiles([String? studyId]) → Future<List<CarpFileResponse>>
Get all file objects in the study.
getConsentDocument(int id, {String? studyDeploymentId}) → Future<ConsentDocument>
Get a previously uploaded (signed) consent document with document id.
getConsentDocumentEndpointUri([String? studyDeploymentId]) → String
The URL for the consent document end point for studyDeploymentId.
getDocumentEndpointUri([String? studyId]) → String
The URL for the document end point for study with id studyId.
getFileEndpointUri([String? studyId]) → String
The URL for the file end point for study with id studyId.
getFileStorageReference([int id = -1, String? studyId]) → FileStorageReference
Get a FileStorageReference that reference a file with id for the study with id studyId. id can be omitted if a local file is not uploaded yet. studyId can be omitted if specified as part of this service's study.
getFileStorageReferenceByName(String name, {String? studyId}) → Future<FileStorageReference?>
Get a FileStorageReference that reference a file with the original name name for study with id studyId.
getStudyDeploymentId(String? studyDeploymentId) → String
Resolve study deployment ID.
inherited
getStudyId(String? studyId) → String
Resolve study ID.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
queryFiles(String? query, {String? studyId}) → Future<List<CarpFileResponse>>
Returns file objects in the study based on a query.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited