Package-level declarations

Contains classes and interfaces common to all features.

Common

The common package contains common declarations for all features, e.g. SdkReleasable.

Types

Link copied to clipboard
interface Callback

The common base class for all listeners used to make callbacks with results.

Link copied to clipboard
annotation class CallbackType(val type: CallbackType.Type)

Annotation used to mark API calls in order to distinguish one shot use cases from multishot use cases. Multishot calls allow more than one call to the Callback interface, meaning that more than one result will be received.

Link copied to clipboard
annotation class Deprecated(val version: Int, val description: String = "")

Annotation specifies in which version of Vehicle Integration Library specific API has been deprecated. APIs annotated with annotations that have value UNRELEASED mean that API is planned for deprecation in next release

Link copied to clipboard
sealed class Result<out S, out F>

Generic response for api calls which wraps and encapsulates responses from Vehicle Integration Library. The Vehicle Integration Library should return an instance of this class every time when answer for requested operation could have 2 possible outcomes. The instance of Result.Success class will be returned in case when the requested operation is successfully finished and instance of Result.Failure will be returned in case when it is not possible to finished the operation successfully.

Link copied to clipboard
interface ResultCallback<S, F> : Callback

Callback with added onResult method.

Link copied to clipboard
fun interface SdkReleasable

Object returned from API methods which allows client to release resources associated with performed action and/or to stop receiving updates through callback.

Link copied to clipboard
annotation class Since(val version: Int)

Annotation specifies in which version of Vehicle Integration Library specific API has been released. APIs annotated with annotations that have value UNRELEASED mean that API can change or be removed at any point. UNRELEASED should also be used for newly added APIs, it will then be changed to a proper version with the next release.

Properties

Link copied to clipboard
const val UNRELEASED: Int