Initialization
API Interface / Android
Last updated
API Interface / Android
Last updated
The Android MOVE SDK must be initialized by adding MoveSdk.init() at the first line in your Android Application class (onCreate). This instance can then be used to control MOVE SDK services. Check for more details.
After the MOVE SDK has been initialized you also want to add notifications, listeners or activate additional features.
Also you have to configure the MOVE SDK before you are able to call .setup(...).
Whenever you are ready to start the Move SDK, setup() needs to be called with a proper configuration.
It is recommended to set up notifications before calling the setup() method.
It is recommended that .setup(...) is called ONLY ONCE! If .shutdown() was called then the setup process must be executed again.
auth
The user's Auth object.
config
The move configuration
start
Boolean
motionPermissionRequired
Boolean
Parameter
Description
listener
Block that gets invoked on initialization completion with error. On error,
Callback
AuthStateUpdateListener
Parameter
Description
listener
Parameter
Description
listener
Parameter
Description
notification
The notification builder to build the notification
Parameter
Description
notification
The notification builder to build the notification
Parameter
Description
notification
The notification builder to build the notification
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.
Parameter
Description
allow
Allows driving with mock locations. Should only be used in debug/test builds
Host apps can use this API to add any app-level information (for ex. bluetooth beacon detected, foreground/background time, etc) to append to a trip as metadata. This metadata will be forwarded back along with the trip when fetched by the client-server, so the host app can utilize it in its app. Note: The MOVE SDK will not use this metadata element in any way, it is just passed through to the project.
The block provides the trip's start and stop times. Make sure to only include metadata events that are collected inside the given start and end periods.
Parameter
Description
Callback to provide a bundle of key-value pairs to a trip. The trip is represented with a given start and stop time.
Parameter
Description
context
Main application context.
Return
MoveSdk
The instance of the MoveSdk
Throws
MissingAuthenticationException
If the passed configuration is missing, e.g. empty access token
The data for the MoveAuth object must be fetched using the given project’s API Key (see ).
is calling automatically
Default value is false. Pass true if you want the Motion Permission() to be mandatory for service
Passing the authentication config is required for each setup. The host app is also responsible for monitoring the changes.
Block that gets invoked on initialization completion with error. On error, is returned. On success, the will change accordingly.
is returned.
Provide a block to be invoked every time changes.
Block that gets invoked every time is updated.
The host app is expected to monitor updates viaauthStateUpdateListener
API and handle those changes accordingly.
Check for more details about authentication expiry and renewal.
Provide a block to be invoked every time changes.
The host app is expected to be monitoring changes so it can start the SDK services when is.ready
or handle errors if occurred.
Block gets called whenever the changes.
A listener where gets called whenever the changes
Passes a notification builder which is used to create a notification reaching places and walking paths. For more information on that please check.
Passes a notification builder which is used to create a notification for places and walking paths. For more information on that please check.
Passes a notification builder which is used to create notification while detecting activities, trips and more. For more information on that, please check.
Tries to initialize the MOVE SDK. You can only have one initialized MOVE SDK at a time. If you have a MOVE SDK instance already, consider calling before.
The initialization process is asynchronous and the host app is expected to register a to monitor successful initialization and start services when transits toREADY
. The host app should also monitor to handle potential .
If you have already successfull initialized the MOVE SDK once, try to initialize the MOVE SDK next time in your application in . This ensures that the MOVE SDK can do its work whenever the application is restarted after termination.