platform_updater_api_common_updater/com.tomtom.ivi.platform.updater.api.common.updater

Package-level declarations

This package contains data classes representing update information.

Types

DetectUpdateHandlerId

value class DetectUpdateHandlerId(val id: String) : Parcelable

A unique identifier for detecting updates for one or more update components.

DetectUpdateResult

@IviExperimental(reasons = [])

enum DetectUpdateResult : Enum<DetectUpdateResult>

Detect update check result.

DownloadFailureReason

@IviExperimental(reasons = [])

enum DownloadFailureReason : Enum<DownloadFailureReason>

Defines the download failure reason.

DownloadPauseReason

@IviExperimental(reasons = [])

enum DownloadPauseReason : Enum<DownloadPauseReason>

Defines the reason why a download is paused.

InstallRequirement

@IviExperimental(reasons = [])

@Serializable

enum InstallRequirement : Enum<InstallRequirement>

Defines the requirement that needs to be met before an update can be installed.

PostInstallAction

@IviExperimental(reasons = [])

enum PostInstallAction : Enum<PostInstallAction>

Action to be performed after an update installation is applied.

@IviExperimental(reasons = [])

data class Update(val info: UpdateInfo, val localization: UpdateLocalization) : Parcelable

Holds all the data associated with an update.

UpdateCancelReason

@IviExperimental(reasons = [])

enum UpdateCancelReason : Enum<UpdateCancelReason>

Defines the update cancellation reason.

UpdateComponentId

@IviExperimental(reasons = [])

@Serializable

value class UpdateComponentId(val id: String) : Parcelable

Unique identifier for the component to be updated.

UpdateComponentInfo

@IviExperimental(reasons = [])

data class UpdateComponentInfo(val id: UpdateComponentId, val displayName: StringResolver, val updates: List<Update> = emptyList(), val requiresOptIn: Boolean = false) : Parcelable

All information regarding an updatable component.

@Serializable

value class UpdateFeedId(val id: String) : Parcelable

Identifies an update feed.

@IviExperimental(reasons = [])

@Serializable(with = UpdateIdSerializer::class)

data class UpdateId(val updateComponentId: UpdateComponentId, val versionInfo: VersionInfo) : Parcelable

Used to uniquely identify the update.

@IviExperimental(reasons = [])

@Serializable

data class UpdateInfo(val updateId: UpdateId, val urgency: UpdateUrgency, val timeToStartUpdate: Instant? = null, val sizeInBytes: Long?, val installRequirements: EnumSet<InstallRequirement> = EnumSet.noneOf(InstallRequirement::class.java), val estimatedDownloadTime: Duration? = null, val estimatedInstallTime: Duration? = null, val estimatedOutOfOrderTime: Duration? = null, val postInstallActions: List<PostInstallAction> = emptyList(), val status: UpdateStatus = UpdateStatus.DownloadPending, val dependenciesBetweenUpdates: List<UpdateId> = emptyList(), val updateFeedId: UpdateFeedId = UpdateFeedId.RELEASE) : Parcelable

Holds all the meta-data associated with an update.

UpdateLocalization

@IviExperimental(reasons = [])

data class UpdateLocalization(val versionName: StringResolver, val releaseNotes: StringResolver? = null, val downloadCompleteMessage: StringResolver? = null, val downloadFailedMessage: StringResolver? = null, val installationCompleteMessage: StringResolver? = null, val installationFailedMessage: StringResolver? = null) : Parcelable

Localization of an update.

@IviExperimental(reasons = [])

data class UpdatePolicy(val urgency: UpdateUrgency, val installRequirements: EnumSet<InstallRequirement> = EnumSet.noneOf(InstallRequirement::class.java), val postInstallActions: List<PostInstallAction> = emptyList())

Defines the policy of an update.

UpdaterNotification

@IviExperimental(reasons = [])

sealed class UpdaterNotification : Parcelable

Notifications for software component updates.

@IviExperimental(reasons = [])

@Serializable

sealed class UpdateStatus : Parcelable

Update status.

@IviExperimental(reasons = [])

sealed class UpdateUiEvent : Parcelable

UI events for an update.

UpdateUiEventData

@IviExperimental(reasons = [])

data class UpdateUiEventData(val event: UpdateUiEvent, val updateId: UpdateId) : Parcelable

An UpdateUiEvent associated to an updateId.

@IviExperimental(reasons = [])

enum UpdateUrgency : Enum<UpdateUrgency>

How urgently should an update be applied.

@Serializable

@IviExperimental(reasons = [])

data class VersionInfo(val versionName: String, val versionCode: Long?) : Parcelable

Version information.

Functions

isDowngradeOrSame

@IviExperimental(reasons = [])

fun VersionInfo.isDowngradeOrSame(other: VersionInfo, versionInfoComparator: Comparator<VersionInfo>): Boolean

Returns true if this version is a downgrade compared to other or if this version is the same as other.

@IviExperimental(reasons = [])

fun UpdateStatus.isFinalState(): Boolean

Returns true if the update state is a final state.

@IviExperimental(reasons = [])

fun Update.isInFinalState(): Boolean

@IviExperimental(reasons = [])

fun UpdateInfo.isInFinalState(): Boolean

Returns true if the update is in a final state.

@IviExperimental(reasons = [])

fun PackageInfo.toVersion(): VersionInfo

Creates a VersionInfo from a PackageInfo instance.