Listeners/Callbacks

MOVE Models

SDK State Listener

Triggers whenever the MoveSDKState changes.

Set an MOVE SDK State listener usingsdkStateListener(Android/iOS) API to anticipate handling the MOVE SDK State changes, start detection services when MoveSDKState is .ready or handle.error if occurred.

For android platform it is necessary to start listen explicitly by calling:

if (Platform.OS === 'android') {
    MoveSdk.startNativeSdkStateListener();
}

Android

interface StateListener {
    fun onStateChanged(sdk: MoveSdk, state: MoveSdkState)
}

iOS

typealias MoveSDKStateCallback = (_ state: MoveSDKState) -> Void

React Native

static addSdkStateListener(sdkStateChanged: (state: SdkState) => void): ListenerSubscription;

Flutter

Stream<MoveState>

Parameter
MoveSDKState	Latest MoveSDKState.

Auth State Update Listener

Triggers whenever the MoveAuthState changes.

Authentication Expiry

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

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

Android

interface AuthStateUpdateListener {
    fun onAuthStateUpdate(state: MoveAuthState)
}

iOS

typealias MoveAuthStateCallback = (_ state: MoveAuthState) -> Void

React Native

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

Flutter

Stream<MoveAuthState>

Parameter
MoveAuthState	Latest MoveAuthState.

Trip State Listener

Triggers whenever the MoveTripState changes.

Android

interface TripStateListener {
    fun onTripStateChanged(sdk: MoveSdk, tripState: MoveTripState)
}

iOS

typealias MoveTripStateCallback = (_ tripState: MoveTripState) -> Void

React Native

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

Flutter

Stream<MoveTripState>

Parameter
MoveTripState	Latest MoveTripState.

Trip Start Listener

Triggers whenever a trip actually starts.

Android

interface TripStartListener {
    fun onTripStarted(startDate: Date)
}

iOS

typealias MoveTripStartCallback = (_ startDate: Date) -> Void

React Native

MoveSdk.addTripStartListener(tripStartTriggered: (start: Date) => void): ListenerSubscription;

Parameter
Date	The actual start time of the trip.

Trip Metadata Provider

This triggers whenever a trip is ending, allowing the host app to append metadata along with that trip if needed.

Trip Metadata is only available for car, cycling, train, tram, metro, and bus items. Metadata is also unavailable if public transport data is sourced from POIs.

Android

interface TripMetadataProvider {
    fun provideMetadata(start: Long, end: Long): Map<String, String>
}

iOS

typealias MoveMetaDataCallback = (_ tripStart: Date, _ tripEnd: Date) -> [String: String]

Parameter	Type
start / tripStart	Long / Date	Trip start timestamp / date.
end / tripEnd	Long / Date	Trip end timestamp / date.

Return
A String dictionary of the trip's metadata.

Device Status Callback

Triggers whenever MoveDeviceStatus changes. MoveDeviceStatus represents the current device's system permissions (for Android / iOS) and services status.

iOS

typealias MoveDeviceStatusCallback = (_ status: MoveDeviceStatus) -> Void

Parameter
MoveDeviceStatus	Latest MoveDeviceStatus.

Service Failure Callback

Triggers whenever MoveServiceFailures change.

Android

interface MoveErrorListener {
    fun onMoveError(serviceFailures: List<MoveServiceFailure>)
}

iOS

public typealias MoveServiceFailureCallback = (_ permissions: [MoveServiceFailure]) -> Void

React Native

static addErrorsListener(errorsReceived: (errors: ErrorListType) => void): ListenerSubscription;

Flutter

Stream<List<MoveServiceError>>

Parameter
MoveServiceFailure	List of MoveServiceFailures.

Service Warning Callback

Triggers whenever MoveServiceWarnings change.

Android

interface MoveWarningListener {
    fun onMoveWarning(serviceWarnings: List<MoveServiceWarning>)
}

iOS

public typealias MoveServiceWarningCallback = (_ permissions: [MoveServiceWarning]) -> Void

React Native

static addWarningsListener(warningsReceived: (warnings: ErrorListType) => void): ListenerSubscription;

Flutter

Stream<List<MoveServiceWarning>>

Parameter
MoveServiceWarning	List of MoveServiceWarnings.

Initialization Listener

Represents the potential errors occurring when updating the MoveAuth.

Android

interface InitializeListener {
    fun onError(error: MoveConfigurationError)
}

iOS

public typealias MoveInitializationCallback = (_ error: MoveConfigurationError) -> Void

Parameter	Type
error	MoveConfigurationError	An error to notify when the configuration could not be loaded from the server.

Log Callback

Triggers whenever a new log event occurs.

Android

interface MoveLogCallback {
    fun onLogReceived(eventName: String, value: String?)
}

iOS

typealias MoveLogCallback = (_ log: String, _ value: String) -> Void

React Native

static addLogListener(logReceived: (event: MoveSdkLog) => void): ListenerSubscription;

export type MoveSdkLog = {
  message: string;
  value?: string;
};

Parameter	Type
log	String	New log event.
value	String	Log value. Optional

The SDK will trigger log messages to improve debugging.

Remote Config Change Listener

Since MOVE SDK v2.5

Will be triggered when the MoveConfig was successfully fetched from the server via updateConfig (Android) / update (iOS).

If the MoveConfig object couldn't be fetched from the server then a MoveConfigurationError ServiceUnreachable will be triggered.

Android

interface RemoteConfigChangeListener {
    fun onConfigChanged(config: MoveConfig)
}

iOS

typealias MoveRemoteConfigChangeCallback = (_ config: MoveConfig) -> Voidstatic addConfigChange(warningsReceived: (warnings: ErrorListType) => void): ListenerSubscription

React Native

static addRemoteConfigChangeListener(configChangeReceived: (config: Array<IssueListService>) => void): ListenerSubscription

Flutter

Stream<MoveConfig>

Setup Authorization Callback

Since MOVE SDK v2.9

Will return the success or failure of the internal MOVE SDK authentication process during setup. (also see MoveAuthResult)

Android

interface MoveAuthCallback {
    fun onResult(result: MoveAuthResult)
}

iOS

typealias MoveAuthCallback = (_ result: MoveAuthResult) -> Void

React Native

Flutter

object : MoveSdk.MoveAuthCallback {
    override fun onResult(authResult: MoveAuthResult) {
        uiThreadHandler.post {
            ...
            when (authResult.status) {
                AuthSetupStatus.SUCCESS -> result.success("success")
                AuthSetupStatus.INVALID_CODE -> // e.g. result.error(...)
                AuthSetupStatus.NETWORK_ERROR -> // e.g. result.error(...)
            }
        }
    }
}

Device Discovery Listener

Since MOVE SDK v2.4

Will be triggered during a BDD - Device Discovery scan.

Android

interface DeviceDiscoveryListener {
    fun onScanResult(results: List<MoveScanResult)
}

iOS

typealias MoveDeviceDiscoveryCallback = (_ results: [MoveScanResult]) -> Void

React Native

static addDeviceDiscoveryListener(onScanResult: (state: Array<MoveScanResult>) => void): ListenerSubscription

Flutter

Stream<List<MoveScanResult>>

Parameter
results	List of MoveScanResult's

MoveDevice State Listener / Callback

Since MOVE SDK v2.10.0

Will be triggered when the status of a registered MoveDevice changes. This MoveDevice must be previously registered. See chapters "Register Device" (Android, iOS)

Android

interface MoveDeviceStateListener {
    fun onStateChanged(device: MoveDevice)
}

iOS

public typealias MoveDeviceStateCallback = (_ results: [MoveDevice]) -> Void

React Native

static addDeviceStateListener(onScanResult: (results: Array<MoveSdkDevice>) => void): ListenerSubscription

Flutter

Stream<List<MoveDevice>>

SDK Health Listener / Callback

Since MOVE SDK v2.11.0

Will be triggered when the health score of the MOVE SDK changes. A MoveHealthItem (iOS, React Native) / MoveHealthScore (Android) with the current data is provided.

Android

interface MoveHealthScoreListener {
    fun onMoveHealthScoreChanged(score: MoveHealthScore)
}

iOS

public typealias MoveHealthScoreCallback = (_ result: [MoveHealthItem]) -> Void

React Native

static addHealthListener(scoreReceived: (health: MoveHealthScore) => void): ListenerSubscription

Flutter

Stream<List<MoveHealthItem>>