Settings class
Misc. settings for CAMS.
This class is a singleton, access using Settings()
.
Must be initialized using the init method before used.
Supports:
- setting debug level - see debugLevel
- setting whether to save AppTasks across app re-start - see saveAppTaskQueue
- getting shared preferences - see preferences
- getting app info - see packageInfo
- generating a unique and anonymous user id - see userId
- getting the timezone of the app - see timezone
Constructors
- Settings()
-
factory
Properties
- appName → String?
-
The app name.
CFBundleDisplayName
on iOS,application/label
on Android.no setter - buildNumber → String?
-
The build number.
CFBundleVersion
on iOS,versionCode
on Android.no setter -
carpBasePath
→ Future<
String> -
The base path for storing all CARP related files on the form
no setter
- debugLevel ↔ DebugLevel
-
The global debug level setting.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialized → bool
-
Has the setting been initialized via calling the init method?
no setter
-
localApplicationPath
→ Future<
String> -
Path to a directory where the application may place data that is
user-generated.
no setter
- packageInfo → PackageInfo?
-
Package information
no setter
- packageName → String?
-
The package name.
bundleIdentifier
on iOS,getPackageName
on Android.no setter - preferences → SharedPreferences?
-
A simple persistent store for simple data. Note that data is saved in
plain format and should hence not be used for sensitive data.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- saveAppTaskQueue ↔ bool
-
Save the queue of AppTasks in the AppTaskController across
app re-start?
getter/setter pair
- timezone → String
-
The local time zone setting of this app.
no setter
-
userId
→ Future<
String> -
Generate a user id that is;
no setter
- version → String?
-
The package version.
CFBundleShortVersionString
on iOS,versionName
on Android.no setter
Methods
-
getCacheBasePath(
String studyDeploymentId) → Future< String> - The base path for storing all cached data.
-
getDataBasePath(
String studyDeploymentId) → Future< String> - The base path for storing all data (e.g. media files).
-
getDeploymentBasePath(
String studyDeploymentId) → Future< String> - The base path for storing all deployment related files on the form
-
init(
) → Future< void> - Initialize settings. Must be called before using any settings.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- CARP_CACHE_FILE_PATH → const String
- CARP_DATA_FILE_PATH → const String
- CARP_DEPLOYMENT_FILE_PATH → const String
- CARP_RESOURCE_FILE_PATH → const String
- USER_ID_KEY → const String