ApiClient

The general interface that exposes pCloud API's methods.

The class is a factory for Call objects which can be used to execute certain operations on a pCloud account.

The ApiClient is designed with reuse in mind, it's best used when created once and shared among code using it, mainly due to used connection and thread pooling.

Users should configure and create instances through the Builder interface.
Builder instances can be created via the newClientBuilder method or from an existing ApiClient instance through the newBuilder method.
Shared instance's configuration can be changed by using the newBuilder method that will return a pre-configured builder.
There is no explicit need to call shutdown, any idle threads and connections will automatically get closed once not used anymore.
All methods return non-null Call instances.
All methods are thread-safe.
All calls resulting in a collection of objects, return unmodifiable java.util.Collection-derived objects.

Bear in mind that shutting down a instance will also affect all instances sharing the underlying resources.

Types

Builder

interface Builder

A builder for configuring an creating new ApiClient instances.

Functions

apiHost

abstract fun apiHost(): String

authenticator

abstract fun authenticator(): Authenticator

cache

abstract fun cache(): Cache

callbackExecutor

abstract fun callbackExecutor(): Executor

connectionPool

abstract fun connectionPool(): ConnectionPool

connectTimeoutMs

abstract fun connectTimeoutMs(): Int

copy

abstract fun copy(file: RemoteEntry, toFolder: RemoteFolder): Call<out RemoteEntry>

abstract fun copy(id: String, toFolderId: Long): Call<out RemoteEntry>

abstract fun copy(file: RemoteEntry, toFolder: RemoteFolder, overwriteFiles: Boolean): Call<out RemoteEntry>

abstract fun copy(id: String, toFolderId: Long, overwriteFiles: Boolean): Call<out RemoteEntry>

Copy a specified file or folder.

copyFile

abstract fun copyFile(file: RemoteFile, toFolder: RemoteFolder): Call<RemoteFile>

abstract fun copyFile(fileId: Long, toFolderId: Long): Call<RemoteFile>

abstract fun copyFile(file: RemoteFile, toFolder: RemoteFolder, overwrite: Boolean): Call<RemoteFile>

abstract fun copyFile(fileId: Long, toFolderId: Long, overwrite: Boolean): Call<RemoteFile>

Copy a specified file.

copyFolder

abstract fun copyFolder(folder: RemoteFolder, toFolder: RemoteFolder): Call<RemoteFolder>

abstract fun copyFolder(folderId: Long, toFolderId: Long): Call<RemoteFolder>

abstract fun copyFolder(folder: RemoteFolder, toFolder: RemoteFolder, overwrite: Boolean): Call<RemoteFolder>

abstract fun copyFolder(folderId: Long, toFolderId: Long, overwrite: Boolean): Call<RemoteFolder>

Copy specified folder.

createFile

abstract fun createFile(folder: RemoteFolder, filename: String, data: DataSource): Call<RemoteFile>

abstract fun createFile(path: String, filename: String, data: DataSource): Call<RemoteFile>

abstract fun createFile(folderId: Long, filename: String, data: DataSource): Call<RemoteFile>

abstract fun createFile(folder: RemoteFolder, filename: String, data: DataSource, uploadOptions: UploadOptions): Call<RemoteFile>

abstract fun createFile(path: String, filename: String, data: DataSource, uploadOptions: UploadOptions): Call<RemoteFile>

abstract fun createFile(folderId: Long, filename: String, data: DataSource, uploadOptions: UploadOptions): Call<RemoteFile>

abstract fun createFile(folder: RemoteFolder, filename: String, data: DataSource, modifiedDate: Date, listener: ProgressListener): Call<RemoteFile>

abstract fun createFile(path: String, filename: String, data: DataSource, modifiedDate: Date, listener: ProgressListener): Call<RemoteFile>

abstract fun createFile(folderId: Long, filename: String, data: DataSource, modifiedDate: Date, listener: ProgressListener): Call<RemoteFile>

abstract fun createFile(folder: RemoteFolder, filename: String, data: DataSource, modifiedDate: Date, listener: ProgressListener, uploadOptions: UploadOptions): Call<RemoteFile>

abstract fun createFile(path: String, filename: String, data: DataSource, modifiedDate: Date, listener: ProgressListener, uploadOptions: UploadOptions): Call<RemoteFile>

abstract fun createFile(folderId: Long, filename: String, data: DataSource, modifiedDate: Date, listener: ProgressListener, uploadOptions: UploadOptions): Call<RemoteFile>

Create a new file.

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.

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.

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.

createFolder