FileBoxItem

interface FileBoxItem

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard
abstract val fileName: String
Link copied to clipboard
abstract val filePath: String
Link copied to clipboard
abstract val id: Long
Link copied to clipboard
abstract val isOwnItem: Boolean
Link copied to clipboard
abstract val sizeInBytes: Long
Link copied to clipboard
abstract val state: FileBoxItem.State

Functions

Link copied to clipboard

Register a StateChangeCallback instance that receives state changes callbacks.

Link copied to clipboard

Register a TransferProgressCallback instance that receives file item transfer progress callbacks.

Link copied to clipboard
abstract fun cancelDownload()

Cancels a running download.

Has no effect if called while the item is not in State TRANSFER_IN_PROGRESS.

Link copied to clipboard
abstract fun removeItem()

Removes this item from the file box. Doesn't remove it locally!

Has no effect if the item was not added by us.

Link copied to clipboard

Unregister a StateChangeCallback previously registered with .addStateChangeCallback. It will not receive any further callbacks.

Link copied to clipboard

Unregister a TransferProgressCallback previously registered with .addTransferProgressCallback. It will not receive any further callbacks.

Link copied to clipboard
abstract fun startDownload()

Starts downloading the item to an app-local location. If you want to specify the download location use the .startDownload method.

abstract fun startDownload(savePath: String?)

Starts downloading the item to a given path.

Has no effect if called while the item is not in State READY_TO_DOWNLOAD.