Skip to content
CARP Documentation

SmartphoneProtocolExtension

Adds the CAMS-specific fields to a SmartphoneStudyProtocol and a SmartphoneDeployment.

The fields (study description, data endpoint, privacy schema, etc.) are kept in a SmartphoneApplicationData object, which is serialized as the applicationData of the carp_core StudyProtocol / PrimaryDeviceDeployment. This way a CAMS protocol can be stored and deployed by any CARP backend.

Mixin applications

Properties

applicationData

Map<String, dynamic>? get applicationData
set applicationData (Map<String, dynamic>? data)

The SmartphoneApplicationData as JSON.

Setting it to null resets all CAMS-specific fields.

applicationName

  1. @JsonKey(includeFromJson: false, includeToJson: false)
String? get applicationName

The name of the application which will execute this protocol.

dataEndPoint

  1. @JsonKey(includeFromJson: false, includeToJson: false)
DataEndPoint? get dataEndPoint
set dataEndPoint (DataEndPoint? dataEndPoint)

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.

description

String get description

The description from studyDescription, or an empty string if none.

hashCode

int get hashCode
inherited

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

privacySchemaName

  1. @JsonKey(includeFromJson: false, includeToJson: false)
String? get privacySchemaName
set privacySchemaName (String? name)

The name of a PrivacySchema to be used for protecting sensitive data.

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

protocolApiLevel

  1. @JsonKey(includeFromJson: false, includeToJson: false)
String? get protocolApiLevel

The API level used by this study protocol.

protocolVersionTag

  1. @JsonKey(includeFromJson: false, includeToJson: false)
String? get protocolVersionTag

The version tag of the study protocol snapshot.

responsible

  1. @JsonKey(includeFromJson: false, includeToJson: false)
StudyResponsible? get responsible

The PI responsible for this protocol, taken from studyDescription.

runtimeType

Type get runtimeType
inherited

A representation of the runtime type of the object.

studyDescription

  1. @JsonKey(includeFromJson: false, includeToJson: false)
StudyDescription? get studyDescription
set studyDescription (StudyDescription? description)

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

Methods

addApplicationData

void addApplicationData(
  1. String key,
  2. dynamic value
)

Adds app-specific value under key.

Use this to store your own data in the protocol. It is copied to all deployments of the protocol and can be read with getApplicationData.

getApplicationData

dynamic getApplicationData(
  1. String key
)

The app-specific value stored under key, or null if none.

noSuchMethod

dynamic noSuchMethod(
  1. Invocation invocation
)
inherited

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

removeApplicationData

void removeApplicationData(
  1. String key
)

toString

String toString()
inherited

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Operators

operator ==

bool operator ==(
  1. Object other
)
inherited

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.