API reference

DownloadError Class

Structured error types for pak download failures. 3p code can pattern-match to decide retry/abort/delete without parsing exception messages.

Signature

sealed class DownloadError

Properties

isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean

Inner Object

Cancelled Object

Signature

object Cancelled : DownloadError

Properties

isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean

Inner Classes

InvalidUri Class

Extends DownloadError
Modifiers: final

Constructors

InvalidUri ( uri , reason )
Signature
constructor(uri: Uri, reason: String)
Parameters
uri: Uri
reason: String
Returns
DownloadError.InvalidUri

Properties

isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean
reason : String
[Get]
Signature
val reason: String
uri : Uri
[Get]
Signature
val uri: Uri

NetworkFailure Class

Extends DownloadError
Modifiers: final

Signature

data class NetworkFailure(val cause: Exception, val httpStatus: Int?) : DownloadError

Constructors

NetworkFailure ( cause , httpStatus )
Signature
constructor(cause: Exception, httpStatus: Int?)
Parameters
cause: Exception
httpStatus: Int?
Returns
DownloadError.NetworkFailure

Properties

cause : Exception
[Get]
Signature
val cause: Exception
httpStatus : Int?
[Get]
Signature
val httpStatus: Int?
isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean

DiskFull Class

Extends DownloadError
Modifiers: final

Signature

data class DiskFull(val bytesWritten: Long, val requiredBytes: Long?) : DownloadError

Constructors

DiskFull ( bytesWritten , requiredBytes )
Signature
constructor(bytesWritten: Long, requiredBytes: Long?)
Parameters
bytesWritten: Long
requiredBytes: Long?
Returns
DownloadError.DiskFull

Properties

bytesWritten : Long
[Get]
Signature
val bytesWritten: Long
isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean
requiredBytes : Long?
[Get]
Signature
val requiredBytes: Long?

IoError Class

Extends DownloadError
Modifiers: final

Signature

data class IoError(val cause: Exception, val path: File) : DownloadError

Constructors

IoError ( cause , path )
Signature
constructor(cause: Exception, path: File)
Parameters
cause: Exception
path: File
Returns
DownloadError.IoError

Properties

cause : Exception
[Get]
Signature
val cause: Exception
isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean
path : File
[Get]
Signature
val path: File

SizeMismatch Class

Extends DownloadError
Modifiers: final

Signature

data class SizeMismatch(val expectedSize: Long, val actualSize: Long) : DownloadError

Constructors

SizeMismatch ( expectedSize , actualSize )
Signature
constructor(expectedSize: Long, actualSize: Long)
Parameters
expectedSize: Long
actualSize: Long
Returns
DownloadError.SizeMismatch

Properties

actualSize : Long
[Get]
Signature
val actualSize: Long
expectedSize : Long
[Get]
Signature
val expectedSize: Long
isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean

ValidationFailed Class

Extends DownloadError
Modifiers: final

Signature

data class ValidationFailed(val reason: String) : DownloadError

Constructors

ValidationFailed ( reason )
Signature
constructor(reason: String)
Parameters
reason: String
Returns
DownloadError.ValidationFailed

Properties

isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean
reason : String
[Get]
Signature
val reason: String

MountValidationFailed Class

Extends DownloadError
Modifiers: final

Signature

data class MountValidationFailed(val mountStatus: PakManager.MountStatus) : DownloadError

Constructors

MountValidationFailed ( mountStatus )
Signature
constructor(mountStatus: PakManager.MountStatus)
Parameters
mountStatus: PakManager.MountStatus
Returns
DownloadError.MountValidationFailed

Properties

isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean
mountStatus : PakManager.MountStatus
[Get]
Signature
val mountStatus: PakManager.MountStatus

Unknown Class

Extends DownloadError
Modifiers: final

Signature

data class Unknown(val cause: Exception) : DownloadError

Constructors

Unknown ( cause )
Signature
constructor(cause: Exception)
Parameters
cause: Exception
Returns
DownloadError.Unknown

Properties

cause : Exception
[Get]
Signature
val cause: Exception
isRetryable : Boolean
[Get]
Signature
val isRetryable: Boolean