• Home
• org.dbtools.kmp
• kmp-commons-jvm
• 0.0.1
• source code
• DirectDownloadRequest.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.org.dbtools.kmp.commons.download.DirectDownloadRequest.kt Maven / Gradle / Ivy

package org.dbtools.kmp.commons.download

import okio.FileSystem
import okio.Path
import kotlin.uuid.Uuid

/**
 * @property downloadUrl Url of file to download
 * @property fileSystem Okio Filesystem that should be used for target file path
 * @property targetFile Okio file Path to target file
 * @property id Unique identifier to help distinguish this DirectDownloadRequest among others
 * @property overwriteExisting If target file exists, allow overwrite? (DEFAULT true)
 * @property customHeaders Extra headers that may need to added to the request (for auth, etc)
 * @property trackProgress Flag for identifying if progress should be tracked (DEFAULT false).  Downloads may be faster
 * @property trackProgressUpdateIntervalSize bytes download interval for progress update (DEFAULT 1000)
 */
data class DirectDownloadRequest(
    val downloadUrl: String,
    val fileSystem: FileSystem,
    val targetFile: Path,
    val id: String = Uuid.random().toString(),
    val overwriteExisting: Boolean = true,
    val customHeaders: List? = null,
    val trackProgress: Boolean = false,
    val trackProgressUpdateIntervalSize: Long = DirectDownloader.DEFAULT_PROGRESS_UPDATE_BYTE_SIZE
)

data class DirectDownloadHeader(
    val name: String,
    val value: String
)