uf-client-service-api/com.kynetics.uf.android.api.v1/UFServiceMessageV1/Event

Event

sealed class Event : UFServiceMessageV1

Class that maps all the events that are notified

Types

AllFilesDownloaded

object AllFilesDownloaded : UFServiceMessageV1.Event

All file needed are downloaded

DownloadProgress

data class DownloadProgress(val fileName: String, val percentage: Double = 0.0) : UFServiceMessageV1.Event

Percent of file downloaded

data class Error(val details: List<String> = emptyList()) : UFServiceMessageV1.Event

An error is occurred

data class FileDownloaded(val fileDownloaded: String) : UFServiceMessageV1.Event

A file is downloaded

object Polling : UFServiceMessageV1.Event

Client is contacting server to retrieve new action to execute

StartDownloadFile

data class StartDownloadFile(val fileName: String) : UFServiceMessageV1.Event

A file downloading is started

UpdateAvailable

data class UpdateAvailable(val id: String) : UFServiceMessageV1.Event

An update is available on cloud

data class UpdateFinished(val successApply: Boolean, val details: List<String> = emptyList()) : UFServiceMessageV1.Event

Update process is finish

data class UpdateProgress( val phaseName: String, val phaseDescription: String = "", val percentage: Double = 0.0) : UFServiceMessageV1.Event

Update phase

Functions

open fun toJson(): String

open override fun toString(): String

Properties

open override val description: String

Message description

open override val name: UFServiceMessageV1.MessageName

Message type

Inheritors

StartDownloadFile

DownloadProgress

AllFilesDownloaded

UpdateAvailable