public interface StorageApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Void> |
createFolder(String path,
String storageName)
Create the folder
|
retrofit2.Call<okhttp3.ResponseBody> |
deleteFile(String path,
String storageName,
String versionId)
Delete file
|
retrofit2.Call<Void> |
deleteFolder(String path,
String storageName,
Boolean recursive)
Delete folder
|
retrofit2.Call<okhttp3.ResponseBody> |
downloadFile(String path,
String storageName,
String versionId)
Download file
|
retrofit2.Call<DiscUsage> |
getDiscUsage(String storageName)
Get disc usage
|
retrofit2.Call<FilesList> |
getFilesList(String path,
String storageName)
Get all files and folders within a folder
|
retrofit2.Call<ObjectExist> |
objectExists(String path,
String storageName,
String versionId)
Check if file or folder exists
|
retrofit2.Call<StorageExist> |
storageExists(String storageName)
Check if storage exists
|
retrofit2.Call<FilesUploadResult> |
uploadFile(okhttp3.MultipartBody.Part file,
String path,
String storageName)
Upload file
|
@Headers(value="Content-Type:application/json") @GET(value="v4.0/html/storage/disc") retrofit2.Call<DiscUsage> getDiscUsage(@Query(value="storageName") String storageName)
storageName
- Storage name (optional)@Headers(value="Content-Type:application/json") @GET(value="v4.0/html/storage/exist") retrofit2.Call<ObjectExist> objectExists(@Query(value="path") String path, @Query(value="storageName") String storageName, @Query(value="versionId") String versionId)
path
- File or folder path e.g. '/file.ext' or '/folder' (required)storageName
- Storage name (optional)versionId
- File version ID (optional)@Headers(value="Content-Type:application/json") @GET(value="v4.0/html/storage/exist/storage") retrofit2.Call<StorageExist> storageExists(@Query(value="storageName") String storageName)
storageName
- Storage name (required)@Headers(value="Content-Type:application/json") @POST(value="v4.0/html/folder") retrofit2.Call<Void> createFolder(@Query(value="path") String path, @Query(value="storageName") String storageName)
path
- Folder path to create e.g. 'folder_1/folder_2/' (required)storageName
- Storage name (optional)@Headers(value="Content-Type:application/json") @GET(value="v4.0/html/folder") retrofit2.Call<FilesList> getFilesList(@Query(value="path") String path, @Query(value="storageName") String storageName)
path
- Folder path e.g. '/folder' (required)storageName
- Storage name (optional)@Headers(value="Content-Type:application/json") @DELETE(value="v4.0/html/folder/") retrofit2.Call<Void> deleteFolder(@Query(value="path") String path, @Query(value="storageName") String storageName, @Query(value="recursive") Boolean recursive)
path
- Folder path e.g. '/folder' (required)storageName
- Storage name (optional)recursive
- Enable to delete folders, subfolders and files (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="v4.0/html/file") retrofit2.Call<okhttp3.ResponseBody> downloadFile(@Query(value="path") String path, @Query(value="storageName") String storageName, @Query(value="versionId") String versionId)
path
- File path e.g. '/folder/file.ext' (required)storageName
- Storage name (optional)versionId
- File version ID to download (optional)@Headers(value="Content-Type:application/json") @DELETE(value="v4.0/html/file") retrofit2.Call<okhttp3.ResponseBody> deleteFile(@Query(value="path") String path, @Query(value="storageName") String storageName, @Query(value="versionId") String versionId)
path
- File path e.g. '/folder/file.ext' (required)storageName
- Storage name (optional)versionId
- File version ID to download (optional)@Multipart @POST(value="v4.0/html/file") retrofit2.Call<FilesUploadResult> uploadFile(@Part okhttp3.MultipartBody.Part file, @Query(value="path") String path, @Query(value="storageName") String storageName)
path
- Path where to upload excluding filename and extension e.g. /Folder1file
- File to upload (required)storageName
- Storage name (optional)Copyright © 2022. All rights reserved.