Initialization
This page shows what can be configured for the MOVE SDK.
Last updated
This page shows what can be configured for the MOVE SDK.
Last updated
The Android MOVE SDK must be initialized by using the MoveSdk.Builder. It can be configured with different configurations. Once the configuration is passed, must be called to initialize and retrieve an instance of the MOVE SDK. This instance can then be used to control SDK services. Check for more details.
To be fetched using the given product’s API Key.
auth
The user's Auth object.
Passing the authentication config is required for each initialization. The host app is also responsible for monitoring the auth state changes.
Parameter
Description
modes
The modes of transport host app require tracking.
Parameter
Description
modes
Driving services host app require tracking.
Parameter
Description
modes
Other services host app requires tracking.
Parameter
Description
listener
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
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 SDK will not use this metadata element in any way, it is just passed through to the product.
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
Block that gets invoked on initialization completion with error. On error, is returned. On success, the will change accordingly.
Block that gets invoked on initialization completion with error. On error, 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
(Android / ) 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 while on an active trip. 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 SDK based on the given configuration. You can only have one initialized MoveSdk at a time. If you have a MoveSDK 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 SDK next time in your application in . This ensures that the SDK can do its work whenever the application is restarted after termination.