createFileLink

abstract fun createFileLink(file: RemoteFile, options: DownloadOptions): Call<FileLink>

Create a download link for a file

If successful, this call will return a FileLink object, which can be used to download the contents of the specified RemoteFile entry. See DownloadOptions for more details on possible options for generating a link.

For more information, see the related documentation page.

Return

Call resulting in a FileLink

See also

Parameters

file

target file. Must not be null.

options

to be used for the link generation. Must not be null.

Throws

on a null options argument.


abstract fun createFileLink(fileId: Long, options: DownloadOptions): Call<FileLink>

Create a download link for a file

If successful, this call will return a FileLink object, which can be used to download the contents of the remote file with the specified fileId. See DownloadOptions for more details on possible options for generating a link.

For more information, see the related documentation page.

Return

Call resulting in a FileLink

See also

Parameters

fileId

the file

options

the options

Throws

on a null options argument.


abstract fun createFileLink(path: String, options: DownloadOptions): Call<FileLink>

Create a download link for a file

If successful, this call will return a FileLink object, which can be used to download the contents of the remote file with the specified path. See DownloadOptions for more details on possible options for generating a link.

For more information, see the related documentation page.

Return

Call resulting in a FileLink

See also

Parameters

path

the file

options

the options

Throws

on a null options argument.