uploadFile

abstract suspend fun uploadFile(request: UploadFileRequest, onProgress: UploadFileProgressListener<SingleFileProgress>? = null): ApiFile

Uploads a single file.

Return

An ApiFile representing the uploaded file.

Parameters

request

The upload request containing the file.

onProgress

Optional listener for upload progress (0.0–1.0).

Samples

// For upload a file use an uploadFile() function.

// Create an UploadFileRequest instance.
val uploadFileRequest = UploadFileRequest(
    file = KoryFile.fromPath("path/to/file.ext")
)

// Send to api...
val response: ApiFile = client.uploadFile(
    request = uploadFileRequest,
    onProgress = { progress ->
        println("Uploading your file to api...\nProgress: ${progress.percentage}%")
    }
)

// Print the result.
println("File successfully uploaded!\nName: ${response.name}, expires at: ${response.expiresAt}")

abstract suspend fun uploadFile(onProgress: UploadFileProgressListener<SingleFileProgress>? = null, block: UploadFileRequestBuilder.() -> Unit): ApiFile

Uploads a single file using the request DSL.

Return

An ApiFile representing the uploaded file.

Parameters

onProgress

Optional listener for upload progress (0.0–1.0).

block

DSL builder for configuring the upload request.

See also

Samples

// For upload a file use an uploadFile() function.
val response: ApiFile = client.uploadFile(
    onProgress = { progress ->
        println("Uploading your file to api...\nProgress: ${progress.percentage}%")
    }
) {
    fileFromPath("path/to/file.ext")
}

println("File successfully uploaded!\nName: ${response.name}, expires at: ${response.expiresAt}")