SmartphoneApplicationData

The CAMS-specific data of a SmartphoneStudyProtocol or SmartphoneDeployment.

Serialized as the applicationData of the carp_core protocol and deployment. You normally access these fields through SmartphoneProtocolExtension.

Annotations

• @JsonSerializable(includeIfNull: false, explicitToJson: true)

Constructors

SmartphoneApplicationData.fromJson

SmartphoneApplicationData.fromJson(

1. Map<String, dynamic> json

)

SmartphoneApplicationData

SmartphoneApplicationData({

1. String? applicationName,
2. StudyDescription? studyDescription,
3. DataEndPoint? dataEndPoint,
4. String? privacySchemaName,
5. Map<String, dynamic>? applicationData,

})

Properties

applicationData

Map<String, dynamic>? applicationData

getter/setter pair

Application-specific data to be stored as part of the study protocol which will be included in all deployments of this study protocol.

applicationName

String? applicationName

getter/setter pair

The name of the application which will execute this protocol. This is the Flutter application name as specified in the pubspec.yaml file of the app executing this protocol. This is used to filter invitations to studies from CAWS.

dataEndPoint

DataEndPoint? dataEndPoint

getter/setter pair

Where and how to store or upload the data collected in this study.

If null, the data is not stored, but can still be used in the app.

privacySchemaName

String? privacySchemaName

getter/setter pair

The name of a PrivacySchema.

Use PrivacySchema.DEFAULT for the default, built-in privacy schema. If not specified, no privacy schema is used and data is saved as collected.

protocolApiLevel

String? protocolApiLevel

getter/setter pair

The API level used by this study protocol. This reflects the version of the CARP Mobile Sensing framework as set in the pubspec.yaml file.

protocolVersionTag

String? protocolVersionTag

getter/setter pair

The version tag of the study protocol snapshot. This is typically set by the CAWS backend when a protocol is uploaded.

studyDescription

StudyDescription? studyDescription

getter/setter pair

The description of this study protocol containing the title, description, purpose, and the responsible researcher for this study.

Methods

toJson

Map<String, dynamic> toJson()