geotabdrivesdk / com.geotab.mobile.sdk.publicInterfaces / DriveSdk

DriveSdk

interface DriveSdk

Properties

isCharging	Charging state of the Android device `abstract val isCharging: Boolean`
webAppLoadFailed	Callback to inform that the Web application can't be loaded, due to network failure. `abstract var webAppLoadFailed: (() -> Unit)?`

Functions

cancelLogin	Cancels the co-driver login view and go back to the drive view `abstract fun cancelLogin(): Unit`
clearDriverActionNecessaryCallback	Clears the previously set driverActionNecessary callback. `abstract fun clearDriverActionNecessaryCallback(): Unit`
clearLastServerAddressUpdatedCallback	Clears the previously set "last server address" callback `abstract fun clearLastServerAddressUpdatedCallback(): Unit`
clearLoginRequiredCallback	Clears the previously set loginRequired callback. `abstract fun clearLoginRequiredCallback(): Unit`
clearPageNavigationCallback	Clears the previously set pageNavigation callback. `abstract fun clearPageNavigationCallback(): Unit`
getAllUsers	Returns all users, including the active driver and co-drivers `abstract fun getAllUsers(callback: (Result<Success<String>, Failure>) -> Unit): Unit`
getAvailability	Returns the active driver's availability hours `abstract fun getAvailability(userName: String, callback: (Result<Success<String>, Failure>) -> Unit): Unit`
getDeviceEvents	Get device events from IOXBLE and IOXUSB as Json string in the callback. Callback returns Json string {Type:Int and DeviceEvent : Json String} `abstract fun getDeviceEvents(callback: (Result<Success<String>, Failure>) -> Unit): Unit`
getHosRuleSet	Returns the configuration of the active driver's current hours of service rule `abstract fun getHosRuleSet(userName: String, callback: (Result<Success<String>, Failure>) -> Unit): Unit`
getStateDevice	Returns Json string with properties of the GO Device `abstract fun getStateDevice(callback: (Result<Success<String>, Failure>) -> Unit): Unit`
getUserViolations	Returns all the violations the active driver has since the start of their cycle `abstract fun getUserViolations(userName: String, callback: (Result<Success<String>, Failure>) -> Unit): Unit`
setCustomURLPath	Set custom url for the webview with the given path and last server address will be the host. `abstract fun setCustomURLPath(path: String): Unit`
setDriverActionNecessaryCallback	`driverActionNecessary` is a list of events that occur in our app where the application owner needs to bring the Drive app activity UI to the foreground. Example: "Your vehicle has been selected by another driver. You now need to select a vehicle". Set a callback to listen for driverActionNecessary events. `abstract fun setDriverActionNecessaryCallback(callback: DriverActionNecessaryCallbackType): Unit`
setDriverSeat	set the vehicle's active driver to the driver id provided. only works with driverId that are logged in tries to perform a Set API call, or updates local database if offline `abstract fun setDriverSeat(driverId: String, callback: (Result<Success<String>, Failure>) -> Unit): Unit`
setLastServerAddressUpdatedCallback	Set a callback to listen for "last server address" change event. LastServerUpdatedCallbackType is a function with the new server address as the argument. `abstract fun setLastServerAddressUpdatedCallback(callback: LastServerUpdatedCallbackType): Unit`
setLoginRequiredCallback	Set a callback to listen for session changes. That includes: no session, invalid session, session expired, co-driver login is requested. There are three defined values and variance of different error messages that could be passed in the callback. `abstract fun setLoginRequiredCallback(callback: LoginRequiredCallbackType): Unit`
setPageNavigationCallback	pageNavigation event indicates any navigation changes by the driver in Geotab Drive. Set a callback to listen for Web Drive's page navigation changes. `abstract fun setPageNavigationCallback(callback: PageNavigationCallbackType): Unit`
setSession	Sets a valid session credential obtained from calling MyGeotab Login API. Set isCoDriver to true if you are adding co-driver. `abstract fun setSession(credentialResult: CredentialResult, isCoDriver: Boolean = false): Unit`
setSpeechEngine	Sets the SpeechEngine used by the SpeechModule `abstract fun setSpeechEngine(speechEngine: SpeechEngine): Unit`