Event

sealed class Event : UFServiceMessageV1

Class that maps all the events that are notified

Types

Link copied to clipboard
object AllFilesDownloaded : UFServiceMessageV1.Event

All file needed are downloaded

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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

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

Percent of file downloaded

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

An error is occurred

Link copied to clipboard
data class FileDownloaded(val fileDownloaded: String) : UFServiceMessageV1.Event

A file is downloaded

Link copied to clipboard
object NewTargetTokenReceived : UFServiceMessageV1.Event

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

Link copied to clipboard
object NoNewState : UFServiceMessageV1.Event

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

Link copied to clipboard
object Polling : UFServiceMessageV1.Event

Client is contacting server to retrieve new action to execute

Link copied to clipboard
data class StartDownloadFile(val fileName: String) : UFServiceMessageV1.Event

A file downloading is started

Link copied to clipboard
data class Started(val configuration: UFServiceConfigurationV2) : UFServiceMessageV1.Event

The service is started

Link copied to clipboard
data class Stopped(val configuration: UFServiceConfigurationV2) : UFServiceMessageV1.Event

The service is stopped

Link copied to clipboard
data class UpdateAvailable(val id: String) : UFServiceMessageV1.Event

An update is available on cloud

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

Update process is finish

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

Update phase

Functions

Link copied to clipboard
open fun toJson(): String
Link copied to clipboard
open override fun toString(): String

Properties

Link copied to clipboard
open override val description: String

Message description

Link copied to clipboard
open override val name: UFServiceMessageV1.MessageName

Message type

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard