SmartPhoneClientManager class
- Inheritance
-
- Object
- ClientManager
- SmartPhoneClientManager
- Mixed-in types
-
Properties
-
deploymentService
↔ DeploymentService?
-
The application service through which study deployments, to be run on
this client, can be managed and retrieved.
getter/setter pairinherited
-
deviceController
↔ DeviceController
-
The controller of connected devices used to collect data locally on
this master device. Also works as a factory which is used to create
DeviceDataCollector instances for connected devices.
getter/setter pairinherited-setteroverride-getter
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
isConfigured
→ bool
-
Determines whether a
DeviceRegistration has been configured for this client,
which is necessary to start adding StudyRuntimes.
no setterinherited
-
notificationController
→ NotificationController?
-
The NotificationController responsible for sending notification on AppTasks.
no setter
-
permissions
↔ Map<Permission, PermissionStatus>?
-
The permissions granted to this client from the OS.
getter/setter pair
-
registration
↔ DeviceRegistration?
-
The registration of this client device.
getter/setter pairinherited
-
repository
↔ Map<Study, StudyRuntime>
-
Repository within which the state of this client is stored.
getter/setter pairinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
activate()
→ void
-
Called when this client manager is being (re-)activated by the OS
-
addStudy(Study study)
→ Future<StudyStatus>
-
Add a study which needs to be executed on this client.
This involves registering this device for the specified study deployment.
override
-
addStudyProtocol(StudyProtocol protocol)
→ Future<Study>
-
Create and add a study based on the
protocol which needs to be executed on
this client. This is similar to the addStudy method, but deploying the
protocol immediately.
-
askForAllPermissions()
→ Future<void>
-
Asking for all permissions needed for the included sampling packages.
-
configure({DeploymentService? deploymentService, DeviceDataCollectorFactory? deviceController, String? deviceId, NotificationController? notificationController, bool enableNotifications = true, bool askForPermissions = true})
→ Future<DeviceRegistration>
-
Configure this SmartPhoneClientManager by specifying:
override
-
deactivate()
→ void
-
Called when this client manager is being deactivated and potentially
stopped by the OS
-
didChangeAccessibilityFeatures()
→ void
-
Called when the system changes the set of currently active accessibility
features.
inherited
-
didChangeAppLifecycleState(AppLifecycleState state)
→ void
-
Called when the system puts the app in the background or returns
the app to the foreground.
override
-
didChangeLocales(List<Locale>? locales)
→ void
-
Called when the system tells the app that the user's locale has
changed. For example, if the user changes the system language
settings.
inherited
-
didChangeMetrics()
→ void
-
Called when the application's dimensions change. For example,
when a phone is rotated.
inherited
-
didChangePlatformBrightness()
→ void
-
Called when the platform brightness changes.
inherited
-
didChangeTextScaleFactor()
→ void
-
Called when the platform's text scale factor changes.
inherited
-
didChangeViewFocus(ViewFocusEvent event)
→ void
-
Called whenever the PlatformDispatcher receives a notification that the
focus state on a view has changed.
inherited
-
didHaveMemoryPressure()
→ void
-
Called when the system is running low on memory.
inherited
-
didPopRoute()
→ Future<bool>
-
Called when the system tells the app to pop the current route, such as
after a system back button press or back gesture.
inherited
-
didPushRoute(String route)
→ Future<bool>
-
Called when the host tells the application to push a new route onto the
navigator.
inherited
-
didPushRouteInformation(RouteInformation routeInformation)
→ Future<bool>
-
Called when the host tells the application to push a new
RouteInformation and a restoration state onto the router.
inherited
-
didRequestAppExit()
→ Future<AppExitResponse>
-
Called when a request is received from the system to exit the application.
inherited
-
dispose()
→ void
-
Called when this client manager is removed from execution permanently.
-
getStudyRuntime(Study study)
→ SmartphoneDeploymentController?
-
Get the
StudyRuntime for a study.
override
-
getStudyStatusList()
→ List<StudyStatus>
-
Get the status for the studies which run on this client device.
inherited
-
handleCancelBackGesture()
→ void
-
Called when a predictive back gesture is canceled, indicating that no
navigation should occur.
inherited
-
handleCommitBackGesture()
→ void
-
Called when a predictive back gesture is finished successfully, indicating
that the current route should be popped.
inherited
-
handleStartBackGesture(PredictiveBackEvent backEvent)
→ bool
-
Called at the start of a predictive back gesture.
inherited
-
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent)
→ void
-
Called when a predictive back gesture moves.
inherited
-
lookupStudyRuntime(String studyDeploymentId, String deviceRoleName)
→ SmartphoneDeploymentController?
-
Lookup the
StudyRuntime based on the studyDeploymentId and deviceRoleName.
override
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
removeStudy(Study study)
→ Future<void>
-
Remove
study from this client manager.
override
-
stopStudy(Study study)
→ Future<void>
-
Permanently stop collecting data for
study and then remove it.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
tryDeployment(Study study)
→ Future<StudyStatus>
-
Verifies whether the device is ready for deployment of the study runtime
identified by
study, and in case it is, deploys.
In case already deployed, nothing happens.
inherited
