core/com.openmobilehub.android.storage.core/OmhStorageClient

OmhStorageClient

abstract class OmhStorageClient(val authClient: OmhAuthClient)

Constructors

OmhStorageClient

protected constructor(authClient: OmhAuthClient)

Types

interface Builder

Properties

protected val authClient: OmhAuthClient

abstract val rootFolder: String

The root folder path of the storage service.

Functions

createFileWithExtension

abstract suspend fun createFileWithExtension(name: String, extension: String, parentId: String): OmhStorageEntity?

This method create file in an specific folder

createFileWithMimeType

abstract suspend fun createFileWithMimeType(name: String, mimeType: String, parentId: String): OmhStorageEntity?

This method create file in an specific folder

abstract suspend fun createFolder(name: String, parentId: String): OmhStorageEntity?

This method create folder in an specific folder

createPermission

abstract suspend fun createPermission(fileId: String, permission: OmhCreatePermission, sendNotificationEmail: Boolean, emailMessage: String?): OmhPermission?

This method update permission role in a given file

abstract suspend fun deleteFile(id: String)

This method delete files with a given file id

deletePermission

abstract suspend fun deletePermission(fileId: String, permissionId: String)

This method delete permission with a given permission id in a given file

abstract suspend fun downloadFile(fileId: String): ByteArrayOutputStream

This method download a file with given id

downloadFileVersion

abstract suspend fun downloadFileVersion(fileId: String, versionId: String): ByteArrayOutputStream

This method download a file version with a given file id and version id

abstract suspend fun exportFile(fileId: String, exportedMimeType: String): ByteArrayOutputStream

This method export a provider application file with a given id to a given mimeType

suspend fun OmhStorageClient.folderSize(folderId: String): Long

Utility method as extension to OmhStorageClient to calculate the total file size of specified folder recursively.

getFileMetadata

abstract suspend fun getFileMetadata(fileId: String): OmhStorageMetadata?

This method retrieves the metadata of a given file

getFilePermissions

abstract suspend fun getFilePermissions(fileId: String): List<OmhPermission>

This method list permissions to a given file

getFileVersions

abstract suspend fun getFileVersions(fileId: String): List<OmhFileVersion>

This method get the versions of a file with a given file id

abstract fun getProviderSdk(): Any

This method provides an escape hatch to access the provider native SDK. This allows developers to use the underlying provider's API directly, should they need to access a feature of the provider that is not supported by the OMH plugin. Refer to the plugin's advanced documentation for type to which to cast the instance.

getStorageQuota

abstract suspend fun getStorageQuota(): Long

This method returns the storage quota available at the storage provider.

getStorageUsage

abstract suspend fun getStorageUsage(): Long

This method returns the total size used at the storage provider.

abstract suspend fun getWebUrl(fileId: String): String?

This method provides a URL that displays the file in the browse

abstract suspend fun listFiles(parentId: String = "root"): List<OmhStorageEntity>

This method list files from an specific folder

permanentlyDeleteFile

abstract suspend fun permanentlyDeleteFile(id: String)

This method permanently delete files with a given file id

abstract suspend fun search(query: String): List<OmhStorageEntity>

This method list files with a name containing the query value.

abstract suspend fun updateFile(localFileToUpload: File, fileId: String): OmhStorageEntity?

This method update a remote file with the content of a local file

updatePermission

abstract suspend fun updatePermission(fileId: String, permissionId: String, role: OmhPermissionRole): OmhPermission?

This method update permission role in a given file

abstract suspend fun uploadFile(localFileToUpload: File, parentId: String?): OmhStorageEntity?

This method upload a file in an specific folder