API reference

DownloadState Class

Represents the current lifecycle state of a pak download.
State transitions:
Idle -> Downloading -> Validating -> Ready
             |              |
             v              v
          Failed         Failed

From Ready, the 3p calls PakManager.mount() themselves.

Signature

sealed class DownloadState

Inner Objects

Inner Classes

Downloading Class

Extends DownloadState
Modifiers: final

Signature

data class Downloading(val progress: DownloadProgress) : DownloadState

Constructors

Downloading ( progress )
Signature
constructor(progress: DownloadProgress)
Parameters
Returns
DownloadState.Downloading

Properties

progress : DownloadProgress
[Get]
Signature
val progress: DownloadProgress

Ready Class

Extends DownloadState
Modifiers: final

Signature

data class Ready(val file: File) : DownloadState

Constructors

Ready ( file )
Signature
constructor(file: File)
Parameters
file: File
Returns
DownloadState.Ready

Properties

file : File
[Get]
Signature
val file: File

Failed Class

Extends DownloadState
Modifiers: final

Signature

data class Failed(val error: DownloadError) : DownloadState

Constructors

Failed ( error )
Signature
constructor(error: DownloadError)
Parameters
Returns
DownloadState.Failed

Properties

[Get]
Signature
val error: DownloadError