Dolphin MOVE SDK
SDK
1.x
1.x
  • Introduction
  • MOVE Services
  • MOVE SDK
    • Getting Started
      • MOVE Dashboard
      • Android
        • Installation
        • Quick Start
      • iOS
        • Installation
        • Quick Start
      • React Native
    • API Interface
      • Android
        • Initialization
        • Services
      • iOS
        • Initialization
        • Services
      • React Native
        • Initialization
        • Services
    • Models
      • MoveAuth
      • MoveConfig
      • MoveConfigurationError
      • MoveDeviceStatus
      • MoveSDKState
      • MoveTripState
      • MoveAuthState
      • Listeners/Callbacks
    • Appendix
      • Android
        • Token refresh
        • Permission Handling
        • Battery optimization
        • Notification Management
      • iOS
        • Permissions Handling
        • App Store
  • MOVE Backend
    • MOVE Timeline
    • MOVE State
    • MOVE Last Location
    • MOVE Generic Notifier
    • Open Api Specification
  • Changelog
    • Android
    • iOS
  • Data privacy (GDPR)
Powered by GitBook
On this page
  • Detection Services
  • Start Automatic Detection
  • Stop Automatic Detection
  • Force Trip Recognition
  • Finish Current Trip
  • Ignore Current Trip
  • Processing Services
  • Keep in foreground
  • Keep active
  • Console logging
  • Get SDK State
  • Get Trip State
  • Get Device Status
  • Delete Local Data
  • Shutdown SDK
  • Synchronize User Data
  • Configuration services
  • Update authentication
  1. MOVE SDK
  2. API Interface
  3. Android

Services

API Interface

PreviousInitializationNextiOS

Last updated 2 years ago

Detection Services

Start Automatic Detection

Starts the required detection services stated in the passed on initialization. Starting the service will set the to Running.

Precondition: SDK should be inREADY.

fun startAutomaticDetection()

Stop Automatic Detection

Stops the automatic detection service, including all SDK services like driving detection, points of interest, walking and places. Stopping the service will set the back to Ready.

Precondition: SDK should be inRunning.

fun stopAutomaticDetection()

Force Trip Recognition

Temporarily calibrates the SDK to the highest detection mode.

In order to optimize battery consumption, the SDK goes through different detection modes with different battery consumption levels, depending on the user's current behavior and activity. In general, the SDK is responsible for alternating between those different detection modes.

The 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 SDK is on the highest detection state to detect the trip faster.

Precondition: SDK should be inRUNNING .

fun forceTripRecognition()
fun forceTripRecognition(duration: Long) 

Parameters

Description

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)

Finish Current Trip

Ends the current ongoing trip.

fun finishCurrentTrip()

If this API is called while the user is active on a driving trip, a new trip will start again right away. If the intention is to un-track the ongoing trip, call ignoreCurrentTripAPI.

Ignore Current Trip

Ignores the current ongoing trip.

fun ignoreCurrentTrip()

Processing Services

Keep in foreground

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.

Disabled by default.

Since it may be annoying to the user, it should only be enabled in case of problems.

fun keepInForeground(enabled: Boolean)

Keep active

Disabled by default.

Since this is consuming more battery, it should only be enabled in case of problems.

fun keepActive(enabled: Boolean)

Console logging

Toggles whether the MOVE SDK is allowed to log into the console or not.

Enabled by default.

fun consoleLogging(enabled: Boolean)
Parameter

enabled

Boolean that sets SDK console logging to enabled or not.

Get SDK State

fun getSDKState() : MoveSDKState

Return

Get Trip State

fun getTripState(): MoveTripState

Return

Get Device Status

fun getDeviceStatus(): MoveDeviceStatus

Return

Delete Local Data

Precondition: SDK should be initialized.

fun deleteLocalData()

Shutdown SDK

Shutdown SDK shared instance.

Precondition: SDK should be initialized.

fun shutdown()

Synchronize User Data

Used to force synchronizing user data with the SDK server. Limited to once per 2 minutes.

fun synchronizeUserData()

Returns FALSE in case there are Timeline-relevant packages in the queue that remain to be sent to the SDK Backend; and it returns TRUE in case the queue is empty.

Configuration services

Update authentication

fun updateAuth(auth: MoveSdk.Auth, onError: (MoveConfigurationError) -> Unit)

Parameters

auth

Valid auth credentials

Callback

onError

This API will end the ongoing trip and set back to .idle. The SDK is responsible for detecting the trip start and end points. The 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 .

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 SDK is using several triggers to start its data listeners. In case of trouble, these triggers can be circumvented by allowing the MoveSdk to stay active all the time. In that case the 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 .

Deletes all the collected user SDK data stored on the device. This doesn't affect the .

Stops SDK services, send the queued user data, and de-initializes the SDK. After that is executed, the will transit to Uninitialised.

Updates SDK . On SDK auth expiry, the Builder.authStateListener will trigger expired state. The host app is expected to fetch a new using its product API key and pass it to the MoveSdk using the following API:

Block that gets invoked on auth update completion error. On completion with error, is passed.

MoveConfig
MoveSdkState
MoveSdkState
MoveSdkState
MoveSdkState
MoveSdkState
MoveTripState
MoveTripState
MoveTripState
MoveTripState
MoveTripState
notification handling
MoveSdkState
MoveTripState
MoveDeviceStatus
MoveSdkState
MoveSdkState
MoveAuth
MoveAuth
MoveSdkState
MoveSdkState
MoveTripState
MoveTripState
MoveDeviceStatus
MoveDeviceStatus
MoveConfigurationError