Services
API Interface / Android
Last updated
API Interface / Android
Last updated
Change the config originally passed in setup.
Parameters
config
Move services configuration.
options
Optional MoveOptions if they need to be changed.
Occasionally this functionality is needed for deployed apps when a projects configuration is updated on the backend.
Starts the required detection services stated in the passed on initialization. Starting the service will set the to Running
.
Precondition: MOVE SDK must be inREADY
.
Temporarily calibrates the MOVE SDK to the highest detection mode.
In order to optimize battery consumption, the MOVE SDK goes through different detection modes with different battery consumption levels, depending on the user's current behavior and activity. In general, the MOVE SDK is responsible for alternating between those different detection modes.
The MOVE SDK also provides hosting apps this API to call if they have their own reasons (like buttons, sensors or beacons) to believe that the user is starting a trip. This will make sure the MOVE SDK is on the highest detection state to detect the trip faster.
Parameters
Type
duration
Long
Limit the high power detection to a certain amount of time in milliseconds, to not drain the battery. Default one minute (60 000ms)
Be sure that you set the start
flag to false
during the MOVE SDK setup.
e.g.:
setup(
auth = moveAuth,
config = moveConfig,
start = false
)
Manually starting a trip bypasses additional trip detection checks. It is strongly recommended to finish manually started trips with finishCurrentTrip()
Starting a trip with startTrip(...) prevents the execution of startAutomaticDetection().
Ends the current ongoing trip.
Ignores the current ongoing trip.
Provides a block to be invoked when a trip actually begins.
In comparison to the tripStateListener (only state changes) the tripStartListener will provide you with the start time of the actual trip.
When an Android application is in the background it may receive limited data (location, sensors, etc.). To improve this behavior, it is possible to put the application always in the foreground with a visible notification that cannot be discarded. Just because it's visible it doesn't mean that it is performing any data collection at all. So this should not have any significant battery impact at all.
Since it may be annoying to the user, it should only be enabled in case of problems.
Since this is consuming more battery, it should only be enabled in case of problems.
Toggles whether the MOVE SDK is allowed to log into the console or not.
Parameters
enabled
Boolean that sets MOVE SDK console logging to enabled or not.
In Android it is possible to use simulated location by enabling it in the device developer mode. If you want the MOVE SDK to support those locations, you need to specify it. By default this is disabled to prevent wrong data.
Points of Interests are not supported with mock locations. Keep in mind that mock locations may have negative impact on trip recognition afterwards.
Parameters
allow
Allows driving with mock locations. Should only be used in debug/test builds
Return
Return
Return
Return
A list of failed services.
Parameters
Block that gets invoked when service failure state changes.
Return
A list of partially working services.
Listener
Block that gets invoked when service warnings change.
Shutdown SDK shared instance.
Precondition: MOVE SDK must be initialized.
Parameters
Default
force
true
If true, shutdown executes immediately. Pending Data may be lost.
callback
null
Parameters
Block that get's invoked when the health score changes.
Geo-coordinate address lookup.
Parameters
latitude
Geo-coordinate latitude
longitude
Geo-coordinate longitude
completion
Geocode will try a reverseGeocodeLocation or fallback to contacting the MOVE backend to attempt a geo-lookup.
Throttle: Geocode is limited to a maximum of 100 lookups per hour.
Used to force synchronizing user data with the MOVE backend. Limited to once per 2 minutes.
The result Returns FALSE in case there are Timeline-relevant packages in the queue that remain to be sent to the MOVE backend; and it returns TRUE in case the queue is empty.
Parameters
result
Optional callback to retrieve result
Adds a Tag (=string value) to trip events. This Tag information is added to the timeline data.
To clear the Tag pass null
as parameter.
Parameters
tag
String [a-z] [0-9]
and null
to clear the Tag.
Return values
true
Live Location Tag is applied.
true
Live Location Tag is cleared. (parameter null
)
false
Live Location Tag exceeds the limit of 200 characters.
false
Live Location Tag is blank or empty.
false
If the passed chars are not one of these [a-z] [0-9].
Initiate an assistance call to emergency services.
Precondition: The assistance call service needs to be configured. The MOVE SDK needs to be in ready or running state.
Parameters
assistanceListener
Get a unique qualifier to identify the individual device.
Parameters
assistanceMetadataValue
String
A string to be sent with each assistance call or impact.
The metadata string is set once, and then sent to the server with each and every manual assistance call and with AID report. The contents of the string can be anything, e.g. JSON data. The assistance data is persisted once set.
Get a unique qualifier to identify the individual device. For Android returns null
Device discovery for Bluetooth devices. Multiple devices can be registered.
The configuration of the scanning will be done with the object DeviceDiscovery
in MoveOptions during MOVE SDK setup. From the start of a trip registered devices are scanned after a startDelay
and are scanned for duration
. This scan will repeat after an interval
.
To scan for Bluetooth devices only once then the flag stopScanOnFirstDiscovered
should be set.
Registering/unregistering devices during a trip may result in undefined behavior.
Parameters
Parameters
Please note that MoveDevices can only be registered if the SDK has been configured with .setup()
Parameters
devices
Parameters
devices
Alternative it is possible to subscribe to registered devices changes.
Deprecated: Token expiry is no longer a valid auth state forwarded to the app and does not need to be handled.
Parameters
listener
A callback returning a MoveConfig object after a successful server fetch.
Stops the automatic detection service, including all MOVE SDK services like driving detection, points of interest, walking and places. Stopping the service will set the back to Ready
.
Precondition: MOVE SDK must be inRunning
.
Precondition: SDK must be inRUNNING
.
Manually force the start of a trip, bypassing trip validation checks. This non-standard SDK usage may be feasible only in situations where active user input can be expected. Using the metadata parameter, self-defined information can be added to each trip which can be fetched from the .
Precondition: MOVE SDK must be in.ready
.
This API will end the ongoing trip and set back to .idle
. The MOVE SDK is responsible for detecting the trip start and end points. The MOVE SDK also provides hosting apps this API to call if they have their own reasons (like sensors or beacons) to believe that the user's trip has ended.
Precondition: should be in an active trip.
More information about trip states can be found in .
If the trip was started with finishCurrentTrip()
brings the SDK back to .ready
state.
This API will set the ongoing to .ignored
. Data of ignored trips is purged and not sent to the server.
Precondition: should be in an active trip.
To save battery consumption, the MOVE SDK is using several triggers to start its data listeners. In case of trouble, these triggers can be circumvented by allowing the MOVE SDK to stay active all the time. In that case the MOVE SDK is always monitoring required data and is therefore consuming more battery. Depending on the configuration, it may happen that the notification (see) is always visible to the user.
Gets the current.
Latest .
Gets the current .
Latest .
Gets the current .
Latest .
Gets the current .
List of
Provide a block to be invoked every time will change.
Gets the current .
List of
Provide a block to be invoked every time will change.
Stops SDK services, send the queued user data, and de-initializes the MOVE SDK. After .shutdown() is executed, the will transit to Uninitialised
.
Returns a upon completion. May fail if not forced.
Provide a block to be invoked every time MoveHealthScorewill change.
Callback that returns a Result with an address String or a
Deletes all the collected user MOVE SDK data stored on the device. This doesn't affect the .
Precondition: should be initialized.
After a shutdown(...)
( / ) the Tag is also cleared.
New feature in MOVE SDK 2.x; configuration in MOVE dashboard pending - please .
A callback returning a .
The device qualifier should be passed to the backend during user registration. See .
Device scanning results are appended to the trip .
Before the DeviceDiscovery configuration can be changed, a with a following must be executed.
Set a device discovery listener to be fired when registered 's are scanned.
If of the object is set to true then the list of MoveScanResults may be incomplete.
listener ->
A callback returning a .
Set a connection state listener to be fired when the Bluetooth connection state of a previously registered has changed.
listener ->
A callback returning the which connection state was changed.
Register 's / add more 's:
A list of 's to be scanned during a trip.
Unregister a :
All devices are unregistered after .
A list of 's that should no longer be scanned during a trip.
Get current registered 's.
Converts into a MOVE SDK specific .
Converts into a MOVE SDK specific .
Updates MOVE SDK . The host app was expected to fetch a new using its project API key and pass it to the MoveSDK using the following API:
Provides a block to be invoked every time was successfully fetched from the server.
If the MoveConfig object couldn't be fetched from the server then a ServiceUnreachable will be triggered.