ServiceConfiguration<TRegistration extends ServiceRegistration> class
A connected device that is a software service rather than hardware.
Examples are an online service, like a weather service, which the app reaches over the internet, or a local service on the phone, like a health service. Its registration is a ServiceRegistration.
- Inheritance
-
- Object
- Serializable
- DeviceConfiguration<
TRegistration> - CamsDevice<
TRegistration> - ServiceConfiguration
- Annotations
-
- @JsonSerializable.new(includeIfNull: false, explicitToJson: true)
Constructors
- ServiceConfiguration({required String roleName, bool? isOptional = true})
-
ServiceConfiguration.fromJson(Map<
String, dynamic> json) -
factory
Properties
- $type ↔ String?
-
The type name written to
__typein JSON; set tojsonTypeon creation.getter/setter pairinherited - dataTypeSamplingSchemes → DataTypeSamplingSchemeMap?
-
Sampling schemes for all the sensors available on this device.
no setterinherited
-
defaultSamplingConfiguration
↔ Map<
String, SamplingConfiguration> ? -
Sampling configurations which override the default configurations for
data types available on this device, mapped by data type.
getter/setter pairinherited
- fromJsonFunction → Function
-
The generated function that converts a JSON map to an object of this type.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- isOptional ↔ bool?
-
Determines whether device registration for this device is optional prior to
starting a study, i.e., whether the study can run without this device or not.
getter/setter pairinherited
- jsonType → String
-
The
__typeused for JSON serialization of this class.no setterinherited - roleName ↔ String
-
A name which describes how the device participates within the study protocol;
its 'role'. For example, 'Parent's phone' or 'Child phone'.
Must be unique within a protocol.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
supportedDataTypes
→ Set<
String> ? -
The set of data types which can be collected on this device.
no setterinherited
- type → String
-
The device type identifier, i.e. its
jsonType.no setterinherited
Methods
-
acceptedRegistration(
DeviceRegistration registration) → DeviceRegistration -
The
registrationin the form the deployment service accepts for this device.inherited -
createRegistration(
{String? deviceId, String? deviceDisplayName}) → TRegistration -
Create a
DeviceRegistrationwhich can be used to configure this device for deployment.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a JSON map of this object, including the
__typeproperty.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited