SharedDefinitions/com.swarovskioptik.comm.definition.topic/InstallationStatus/Data

Data

data class Data(val task: InstallationStatus.Data.InstallationTask, val step: String, val state: InstallationStatus.Data.InstallationState, val progress: Int?, val message: String?)

Parameters

task

The type of task that is being performed / has been initiated, for which this InstallationStatus is emitted.

step

The step within the given task this InstallationStatus is about. Must be one of the constants defined in InstallStep:

state

The state this step has been completed with / is currently in (one of InstallationState.Failed, InstallationState.InProgress or InstallationState.Success)

progress

the progress [0, 100] of the current installation step. Will in practice only contain a value if state is InstallationState.InProgress.

message

A message this InstallationStatus might contain, is required if state indicated an error (InstallationState.Failed).

Constructors

constructor(task: InstallationStatus.Data.InstallationTask, step: String, state: InstallationStatus.Data.InstallationState, progress: Int?, message: String?)

Types

InstallationState

enum InstallationState : Enum<InstallationStatus.Data.InstallationState>

The states any step may be in

InstallationTask

enum InstallationTask : Enum<InstallationStatus.Data.InstallationTask>

The task this InstallationStatus is about.

object InstallStep

Defines the steps that may be set in InstallationStatus.Data.step

Properties

val message: String?

val progress: Int?

val state: InstallationStatus.Data.InstallationState

val step: String

val task: InstallationStatus.Data.InstallationTask