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

CantBeStopped

data class CantBeStopped(val configuration: UFServiceConfigurationV2, val retryIn: Long) : UFServiceMessageV1.Event

The service can't be stopped. It typically happens when an update is currently being installed.

ConfigurationUpdated

data class ConfigurationUpdated(val configuration: UFServiceConfigurationV2) : UFServiceMessageV1.Event

The configuration used by the service has been updated. This event is notified when the configuration change doesn't require a restart of the service.

DeployFeedbackRequestResult

data class DeployFeedbackRequestResult( val success: Boolean, val id: String, val closeAction: Boolean) : UFServiceMessageV1.Event

The result of the deployment feedback request sent to the server

DownloadProgress

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

Percent of file downloaded

Error

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

An error is occurred

FileDownloaded

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

A file is downloaded

NewTargetTokenReceived

object NewTargetTokenReceived : UFServiceMessageV1.Event

The client has received a new target token from the update server.

NoNewState

object NoNewState : UFServiceMessageV1.Event

The client has received a new target token from the update server.

Polling

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

Started

data class Started(val configuration: UFServiceConfigurationV2) : UFServiceMessageV1.Event

The service is started

Stopped

data class Stopped(val configuration: UFServiceConfigurationV2) : UFServiceMessageV1.Event

The service is stopped

UpdateAvailable

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

An update is available on cloud

UpdateFinished

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

Update process is finish

UpdateProgress

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

Update phase

Functions

toJson

open fun toJson(): String

toString

open override fun toString(): String

Properties

description

open override val description: String

Message description

name

open override val name: UFServiceMessageV1.MessageName

Message type

Inheritors