Package com.aspose.html.api
Interface StorageApi
public interface StorageApi
Aspose.HTML Cloud API Reference
Storage API for manipulation with storage objects
-
Method Summary
Modifier and TypeMethodDescriptionretrofit2.Call<Void>
createFolder
(String path, String storageName) Create the folderretrofit2.Call<okhttp3.ResponseBody>
deleteFile
(String path, String storageName, String versionId) Delete fileretrofit2.Call<Void>
deleteFolder
(String path, String storageName, Boolean recursive) Delete folderretrofit2.Call<okhttp3.ResponseBody>
downloadFile
(String path, String storageName, String versionId) Download fileretrofit2.Call<DiscUsage>
getDiscUsage
(String storageName) Get disc usageretrofit2.Call<FilesList>
getFilesList
(String path, String storageName) Get all files and folders within a folderretrofit2.Call<ObjectExist>
objectExists
(String path, String storageName, String versionId) Check if file or folder existsretrofit2.Call<StorageExist>
storageExists
(String storageName) Check if storage existsretrofit2.Call<FilesUploadResult>
uploadFile
(okhttp3.MultipartBody.Part file, String path, String storageName) Upload file
-
Method Details
-
getDiscUsage
@Headers("Content-Type:application/json") @GET("v4.0/html/storage/disc") retrofit2.Call<DiscUsage> getDiscUsage(@Query("storageName") String storageName) Get disc usage- Parameters:
storageName
- Storage name (optional)- Returns:
- Call <DiscUsage>
-
objectExists
@Headers("Content-Type:application/json") @GET("v4.0/html/storage/exist") retrofit2.Call<ObjectExist> objectExists(@Query("path") String path, @Query("storageName") String storageName, @Query("versionId") String versionId) Check if file or folder exists- Parameters:
path
- File or folder path e.g. '/file.ext' or '/folder' (required)storageName
- Storage name (optional)versionId
- File version ID (optional)- Returns:
- Call <ObjectExist>
-
storageExists
@Headers("Content-Type:application/json") @GET("v4.0/html/storage/exist/storage") retrofit2.Call<StorageExist> storageExists(@Query("storageName") String storageName) Check if storage exists- Parameters:
storageName
- Storage name (required)- Returns:
- Call <StorageExist>
-
createFolder
@Headers("Content-Type:application/json") @POST("v4.0/html/folder") retrofit2.Call<Void> createFolder(@Query("path") String path, @Query("storageName") String storageName) Create the folder- Parameters:
path
- Folder path to create e.g. 'folder_1/folder_2/' (required)storageName
- Storage name (optional)- Returns:
- Call <Void>
-
getFilesList
@Headers("Content-Type:application/json") @GET("v4.0/html/folder") retrofit2.Call<FilesList> getFilesList(@Query("path") String path, @Query("storageName") String storageName) Get all files and folders within a folder- Parameters:
path
- Folder path e.g. '/folder' (required)storageName
- Storage name (optional)- Returns:
- Call <FilesList>
-
deleteFolder
@Headers("Content-Type:application/json") @DELETE("v4.0/html/folder/") retrofit2.Call<Void> deleteFolder(@Query("path") String path, @Query("storageName") String storageName, @Query("recursive") Boolean recursive) Delete folder- Parameters:
path
- Folder path e.g. '/folder' (required)storageName
- Storage name (optional)recursive
- Enable to delete folders, subfolders and files (optional, default to false)- Returns:
- Call <Void>
-
downloadFile
@Headers("Content-Type:application/json") @GET("v4.0/html/file") retrofit2.Call<okhttp3.ResponseBody> downloadFile(@Query("path") String path, @Query("storageName") String storageName, @Query("versionId") String versionId) Download file- Parameters:
path
- File path e.g. '/folder/file.ext' (required)storageName
- Storage name (optional)versionId
- File version ID to download (optional)- Returns:
- Call <ResponseBody>
-
deleteFile
@Headers("Content-Type:application/json") @DELETE("v4.0/html/file") retrofit2.Call<okhttp3.ResponseBody> deleteFile(@Query("path") String path, @Query("storageName") String storageName, @Query("versionId") String versionId) Delete file- Parameters:
path
- File path e.g. '/folder/file.ext' (required)storageName
- Storage name (optional)versionId
- File version ID to download (optional)- Returns:
- Call <ResponseBody>
-
uploadFile
@Multipart @POST("v4.0/html/file") retrofit2.Call<FilesUploadResult> uploadFile(@Part okhttp3.MultipartBody.Part file, @Query("path") String path, @Query("storageName") String storageName) Upload file- Parameters:
path
- Path where to upload excluding filename and extension e.g. /Folder1file
- File to upload (required)storageName
- Storage name (optional)- Returns:
- Call <FilesUploadResult>
-