public interface ServiceClientCallback
com.tomtom.business.ubi.core.DirectCoreService
is bound and running any of the listed methods could be triggered and thus should be handled by the custom app.Core
,
ServiceClient
Modifier and Type | Interface and Description |
---|---|
static class |
ServiceClientCallback.ClockSyncForAction
A list of actions denoting the cause of a synchronisation of the clock in the dongle.
|
static class |
ServiceClientCallback.ClockSyncForActionResponse
Encapsulates the cause of the successful synchronisation of the clock.
|
static class |
ServiceClientCallback.ConnectionStatusResponse
Contains the current connection state of the end point specified by
the
ServiceClientCallback.ConnectionStatusResponse.endPoint parameter. |
static class |
ServiceClientCallback.CoreStateResponse
Contains the current state of the Core.
|
static class |
ServiceClientCallback.CrashDetectedDatagramResponse
Contains a datagram containing crash-related data received via
onCrashDetectedDatagram(CrashDetectedDatagramResponse) . |
static class |
ServiceClientCallback.DeviceStatusResponse
Encapsulates the current device status.
|
static class |
ServiceClientCallback.DownloadProgressState
A list of states that indicate the current progress of downloading of driving data from the dongle.
|
static class |
ServiceClientCallback.DownloadStatusResponse
Encapsulates the current progress after calling
ServiceClient.startSync() . |
static class |
ServiceClientCallback.DrivingProfileRealTimeDatagramResponse
Contains a OBD real-time datagram received via
onObdRealTimeDatagram(ObdRealTimeDatagramResponse) . |
static class |
ServiceClientCallback.EndPoint
Definition of end points.
|
static class |
ServiceClientCallback.EngineStatusResponse
Contains a boolean whether the engine was switched on or off.
|
static class |
ServiceClientCallback.FirmwareUpdateAvailableResponse
Encapsulates the information that a firmware update is available.
|
static class |
ServiceClientCallback.FirmwareUpdateStatusResponse
Encapsulates the current progress after a firmware update has been initiated.
|
static class |
ServiceClientCallback.ObdDtcListResponse
Contains a list of DTCs received via
onObdDtcList(ObdDtcListResponse) . |
static class |
ServiceClientCallback.ObdRealTimeDatagramResponse
Contains a OBD real-time datagram received via
onObdRealTimeDatagram(ObdRealTimeDatagramResponse) . |
static class |
ServiceClientCallback.OdometerChangeResponse
Encapsulates the result of a call to
ServiceClient.changeOdometer(OdometerValueParameter) |
static class |
ServiceClientCallback.OutboundQueueStatusUpdateResponse
Contains the current number of messages in the queue specified by
the
ServiceClientCallback.OutboundQueueStatusUpdateResponse.outboundQueue parameter. |
static class |
ServiceClientCallback.TransmissionResponse
Encapsulates a transmission state.
|
static class |
ServiceClientCallback.TransmissionState
Indicates that a piece of communication took place.
|
static class |
ServiceClientCallback.UbiErrorCodeResponse
Upon each error in the Core an error message is also sent back to the custom app.
|
static class |
ServiceClientCallback.UploadToServerFinishedResponse
Encapsulates the creation time of the last UBI data in the dongle.
|
Modifier and Type | Method and Description |
---|---|
void |
onActivationFinished()
Called when the Core was successfully started and the activation was either carried out successfully or already done and valid.
|
void |
onActivationStart()
Called at every start of an activation process.
|
void |
onClockSyncReasonForDownloadRequired()
Called when the Core was initiated to download the driving data from the dongle, but the dongle requested the synchronisation of the
internal clock.
|
void |
onClockSyncSuccesful(ServiceClientCallback.ClockSyncForActionResponse clockSyncReasonForActionResponse)
Setting the clock in the dongle was successful.
|
void |
onConnectionStatusUpdate(ServiceClientCallback.ConnectionStatusResponse connectionStatusResponse)
Called when the connection status to either dongle or server has changed.
|
void |
onCoreBooted()
Called when the Core was successfully started technically.
|
void |
onCoreState(ServiceClientCallback.CoreStateResponse coreStateResponse)
Called after the client requested the status of the Core via
ServiceClient.requestCoreState() or
when the dongle info was updated inside the core state. |
void |
onCrashDetectedDatagram(ServiceClientCallback.CrashDetectedDatagramResponse crashDetectedDatagramResponse)
Called in case the dongle detected a crash.
|
void |
onDeviceStatus(ServiceClientCallback.DeviceStatusResponse deviceStatusResponse)
Called after the client requested the device status via
ServiceClient.requestDeviceStatus() . |
void |
onDownloadStatusUpdate(ServiceClientCallback.DownloadStatusResponse downloadStatusResponse)
Called on every status update of an ongoing download of driving data.
|
void |
onDrivingProfileRealTimeDatagram(ServiceClientCallback.DrivingProfileRealTimeDatagramResponse drivingProfileRealTimeDatagramResponse)
Periodically called after the client requested the start of the continuous transmission of real-time driving profile data via
ServiceClient.startDrivingProfileRealtimeTransmission() . |
void |
onEngineStatusUpdate(ServiceClientCallback.EngineStatusResponse response)
Called when the state of the engine changes.
|
void |
onError(ServiceClientCallback.UbiErrorCodeResponse ubiErrorCodeResponse)
Called on every error that occurs in the Core.
|
void |
onFirmwareUpdateAvailable(ServiceClientCallback.FirmwareUpdateAvailableResponse firmwareUpdateAvailableResponse)
Called when the Core is started, the dongle is properly activated and a firmware update is available on the server.
|
void |
onFirmwareUpdateStatusUpdate(ServiceClientCallback.FirmwareUpdateStatusResponse firmwareUpdateStatusResponse)
Called on every status update of an ongoing firmware update.
|
void |
onObdDtcList(ServiceClientCallback.ObdDtcListResponse obdDtcListResponse)
Called after the client requested a list of current DTC's recorded by the dongle via
ServiceClient.requestObdDtcList() . |
void |
onObdRealTimeDatagram(ServiceClientCallback.ObdRealTimeDatagramResponse obdRealTimeDatagramResponse)
Periodically called after the client requested the start of the continuous transmission of real-time OBD data via
ServiceClient.startObdRealtimeTransmission() . |
void |
onOdometerChange(ServiceClientCallback.OdometerChangeResponse odometerChangeResponse)
Called after the client changed the odometer in the dongle via
ServiceClient.changeOdometer(OdometerValueParameter) . |
void |
onOutboundQueueStatusUpdate(ServiceClientCallback.OutboundQueueStatusUpdateResponse outboundQueueStatusUpdateResponse)
Called when the number of messages in the queue specified by the
ServiceClientCallback.OutboundQueueStatusUpdateResponse.outboundQueue parameter has changed. |
void |
onTransmission(ServiceClientCallback.TransmissionResponse transmissionResponse)
Called when a message was transmitted to either dongle or server.
|
void |
onUploadToServerFinished(ServiceClientCallback.UploadToServerFinishedResponse uploadToServerFinishedResponse)
Indicates the recent upload of UBI data to the server was finished.
|
void onError(ServiceClientCallback.UbiErrorCodeResponse ubiErrorCodeResponse)
void onTransmission(ServiceClientCallback.TransmissionResponse transmissionResponse)
void onOutboundQueueStatusUpdate(ServiceClientCallback.OutboundQueueStatusUpdateResponse outboundQueueStatusUpdateResponse)
ServiceClientCallback.OutboundQueueStatusUpdateResponse.outboundQueue
parameter has changed.
For instance when the client started the synchronisation of driving data the number of messages in the outbound queue of the WEBFLEET server
in the Core will change. This can be used by client to show the current fill level of the outbound queues to give a visual
feedback to the user if there is still data to send.void onConnectionStatusUpdate(ServiceClientCallback.ConnectionStatusResponse connectionStatusResponse)
void onFirmwareUpdateAvailable(ServiceClientCallback.FirmwareUpdateAvailableResponse firmwareUpdateAvailableResponse)
ServiceClientCallback.FirmwareUpdateAvailableResponse
parameter into a FirmwareUpdateParameter
and use ServiceClient.updateFirmware(FirmwareUpdateParameter)
to actually start the firmware update.
The status of the firmware update is reported via onFirmwareUpdateStatusUpdate(FirmwareUpdateStatusResponse)
.void onFirmwareUpdateStatusUpdate(ServiceClientCallback.FirmwareUpdateStatusResponse firmwareUpdateStatusResponse)
void onDownloadStatusUpdate(ServiceClientCallback.DownloadStatusResponse downloadStatusResponse)
ServiceClient.startSync()
.void onActivationStart()
void onActivationFinished()
void onClockSyncReasonForDownloadRequired()
ServiceClient.sendClockSyncReasonForDownload(DisconnectReasonParameter)
to continue the
synchronisation process.void onCoreBooted()
void onClockSyncSuccesful(ServiceClientCallback.ClockSyncForActionResponse clockSyncReasonForActionResponse)
void onDeviceStatus(ServiceClientCallback.DeviceStatusResponse deviceStatusResponse)
ServiceClient.requestDeviceStatus()
.void onOdometerChange(ServiceClientCallback.OdometerChangeResponse odometerChangeResponse)
ServiceClient.changeOdometer(OdometerValueParameter)
.void onCoreState(ServiceClientCallback.CoreStateResponse coreStateResponse)
ServiceClient.requestCoreState()
or
when the dongle info was updated inside the core state.ServiceClientCallback.CoreStateResponse
void onObdRealTimeDatagram(ServiceClientCallback.ObdRealTimeDatagramResponse obdRealTimeDatagramResponse)
ServiceClient.startObdRealtimeTransmission()
. This method is only called if the dongle is
currently connected to the smartphone. The datagram is transmitted even if the dongle is not able to acquire access to the OBD bus.void onDrivingProfileRealTimeDatagram(ServiceClientCallback.DrivingProfileRealTimeDatagramResponse drivingProfileRealTimeDatagramResponse)
ServiceClient.startDrivingProfileRealtimeTransmission()
. This method is only called if the dongle is
currently connected to the smartphone.void onCrashDetectedDatagram(ServiceClientCallback.CrashDetectedDatagramResponse crashDetectedDatagramResponse)
void onUploadToServerFinished(ServiceClientCallback.UploadToServerFinishedResponse uploadToServerFinishedResponse)
void onObdDtcList(ServiceClientCallback.ObdDtcListResponse obdDtcListResponse)
ServiceClient.requestObdDtcList()
.ServiceClientCallback.ObdDtcListResponse
void onEngineStatusUpdate(ServiceClientCallback.EngineStatusResponse response)
ServiceClient.startEngineStatusUpdatesTransmission()
.