Services

React Native

import MoveSdk from 'react-native-move-sdk';

Detection Services

Start Automatic Detection

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

Precondition: SDK should be in.readyMoveSDKState

startAutomaticDetection: () => void

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 MoveSDKState back to .ready.

Precondition: SDK should be in.runningMoveSDKState.

stopAutomaticDetection: () => void

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 in.running MoveSDKState.

forceTripRecognition: () => void

Finish Current Trip

Ends the current ongoing trip.

This API will end the ongoing trip and set MoveTripState 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: MoveTripState should be in an active trip.

finishCurrentTrip: () => void

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.

More information about trip states can be found in MoveTripState.

Ignore Current Trip

Ignores the current ongoing trip.

This API will set the ongoing MoveTripState to .ignored. Data of ignored trips is purged and not sent to the server.

Precondition: MoveTripState should be in an active trip.

ignoreCurrentTrip: () => void

Processing Services

Keep in foreground (Android only)

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.

keepInForeground: (enabled: boolean) => void

Keep active (Android only)

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 notification handling) is always visible to the user.

Disabled by default.

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

keepActive: (enabled: boolean) => void

Get SDK State

Gets the current MoveSDKState.

getState: () => Promise<SdkState>

Return
MoveSDKState	Latest SDK State

Set SDK State Listener

Provide a block to be invoked every time MoveSDKState changes.

Set the MoveSDKState listener before initializing the SDK to anticipate the SDK State changes triggered by the initialization API. Here the host app can start the SDK services when MoveSDKState is.readyor handle errors if occurred.

addSDKStateListener: (
    sdkStateChanged: (event: SdkStateEvent) => void
) => ListenerSubscription

Callback
sdkStateChanged	Block that gets invoked every time MoveSDKState is changed and provides the updated MoveSDKState.

Get SDK Auth State

Gets the current MoveAuthState.

Return
MoveAuthState	Latest SDK State

Set SDK Auth State Listener

Provide a block to be invoked every time MoveAuthState changes.

addAuthStateListener: (
    authStateChanged: (event: AuthStateEvent) => void
) => ListenerSubscription

Callback
authStateChanged	Block that gets invoked every time MoveAuthState is updated.

Authentication Expiry

The host app is expected to monitor MoveAuthState updates viaauthStateUpdateListene API and handle those changes accordingly.

Check Authentication updates and expiry for more details about authentication expiry and renewal.

Get Trip State

Gets the current MoveTripState.

getTripState: () => Promise<TripState>

Return
MoveTripState	Current MoveTripState

Set Trip State Listener

Provide a block to be invoked every time MoveTripState changes.

addTripStateListener: (
    tripStateChanged: (state: TripState) => void
) => ListenerSubscription

Callback
tripStateChanged	Block that gets invoked every time MoveTripState is changed and provides the updated MoveTripState.

Shutdown SDK

Shutdown SDK shared instance.

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

Precondition: SDK should be initialized.

shutdown: () => void

Synchronize User Data

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

synchronizeUserData: () => void

Configuration services

Update authentication

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

updateAuth: (auth: MoveSdkAuth) => Promise<void>

Parameters
auth	The user's updated Auth object with the new token.