LocationService class

An OnlineService for the location manager.

Inheritance
  • Object
  • Serializable
  • DeviceDescriptor
  • OnlineService
  • LocationService
Annotations
  • @JsonSerializable(fieldRename: FieldRename.none, includeIfNull: false)

Constructors

LocationService({String? roleName, List<String>? supportedDataTypes, GeolocationAccuracy accuracy = GeolocationAccuracy.balanced, double distance = 0, Duration? interval, String? notificationTitle, String? notificationMessage, String? notificationDescription})
Create and configure a LocationService.
LocationService.fromJson(Map<String, dynamic> json)
factory

Properties

$type ↔ String?
The runtime class name (type) of this object. Used for deserialization from JSON objects.
getter/setter pairinherited
accuracy ↔ GeolocationAccuracy
Defines the desired accuracy that should be used to determine the location data. Default value is GeolocationAccuracy.balanced.
getter/setter pair
distance ↔ double
The minimum distance in meters a device must move horizontally before an update event is generated. Specify 0 when you want to be notified of all movements.
getter/setter pair
fromJsonFunction → Function
The function which can convert a JSON string to an object of this type.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
interval ↔ Duration
The interval between location updates.
getter/setter pair
isMasterDevice ↔ bool?
Is this the master device?
getter/setter pairinherited
jsonType → String
Return the __type to be used for JSON serialization of this class. Default is runtimeType. Only specify this if you need another type.
no setterinherited
notificationDescription ↔ String?
The longer description in the notification to be shown to the user when location tracking takes place in the background. Only used on Android.
getter/setter pair
notificationMessage ↔ String?
The message in the notification to be shown to the user when location tracking takes place in the background. Only used on Android.
getter/setter pair
notificationTitle ↔ String?
The title of the notification to be shown to the user when location tracking takes place in the background. Only used on Android.
getter/setter pair
roleName ↔ String
The role name of this device in a specific StudyProtocol. For example, 'Parent's phone' or 'Child phone'.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
samplingConfiguration ↔ Map<String, SamplingConfiguration>
Sampling configurations for data types available on this device which override the default configuration.
getter/setter pairinherited
supportedDataTypes ↔ List<String>?
The set of data types which can be collected on this device.
getter/setter pairinherited
type → String
The device type identifier
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Return a JSON encoding of this object.
override
toString() → String
A string representation of this object.
inherited

Operators

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

Constants

DEFAULT_ROLENAME → const String
The default rolename for a location service.
DEVICE_TYPE → const String
The type of a location service.