mosaic-client/dev.catbit.mosaic.client.domain.download/DownloadFileUseCase

DownloadFileUseCase

class DownloadFileUseCase(repository: MosaicRepository) : UseCase<Unit, DownloadFileUseCase.Params>

Downloads a file into the device's public/general storage (system Downloads location) — backs DownloadFile, the only one of the 3 download events whose destination the user can interactively cancel (reflected in DownloadFile's own OnCancelled trigger, handled above this use case). Reachable via get<DownloadFileUseCase>().

Constructors

DownloadFileUseCase

constructor(repository: MosaicRepository)

Types

Params

data class Params(val url: String, val headers: Map<String, String>?, val body: Any?, val httpMethod: HttpMethod, val targetFileName: String, val mimeType: String? = null, val onProgress: suspend (Float) -> Unit = {}, val onDownloadFinished: suspend () -> Unit = {}, val onDownloadFailure: suspend (Throwable) -> Unit = {})

Functions

execute

open suspend override fun execute(params: DownloadFileUseCase.Params): Result<Unit>

invoke

suspend operator fun invoke(params: DownloadFileUseCase.Params): Result<Unit>