---
title: "DownloadEvent"
sidebar_label: "DownloadEvent"
description: "Kotlin binding reference: DownloadEvent."
---

<!-- Generated by tools/api_reference/generate_api_docs.py. Do not edit. -->

//[clika-runtime](../../../index.md)/[io.clika.modelverse](../index.md)/[DownloadEvent](index.md)

# DownloadEvent

[common]\
data class [DownloadEvent](index.md)(val file: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), val index: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html), val count: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html), val done: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), val total: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), val planBytesDone: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), val planBytesTotal: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), val isWeight: [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html))

One step of a download ([DownloadListener](../DownloadListener/index.md)): the file transferring (repo-relative), its position in the plan so far ([index](index-property.md) of [count](count.md); the plan grows as the resolve names its missing files), its bytes, and the plan's bytes done and total ([planBytesTotal](planBytesTotal.md) is 0 while a planned file's size is unknown). A cached file never joins the plan.

## Constructors

| | |
|---|---|
| [DownloadEvent](DownloadEvent.md) | [common]<br>constructor(file: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), index: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html), count: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html), done: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), total: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), planBytesDone: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), planBytesTotal: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), isWeight: [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)) |

## Properties

| Name | Summary |
|---|---|
| [count](count.md) | [common]<br>val [count](count.md): [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) |
| [done](done.md) | [common]<br>val [done](done.md): [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) |
| [file](file.md) | [common]<br>val [file](file.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) |
| [index](index-property.md) | [common]<br>val [index](index-property.md): [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) |
| [isWeight](isWeight.md) | [common]<br>val [isWeight](isWeight.md): [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) |
| [planBytesDone](planBytesDone.md) | [common]<br>val [planBytesDone](planBytesDone.md): [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) |
| [planBytesTotal](planBytesTotal.md) | [common]<br>val [planBytesTotal](planBytesTotal.md): [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) |
| [total](total.md) | [common]<br>val [total](total.md): [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) |