Working with Files in Storage – Aspose.HTML Cloud

Storage Files

Aspose.HTML Cloud allows you to work with storage files - documents saved on the cloud storage and use the storage for various scenarios. The most common use cases are cloud backup, disaster recovery and archiving infrequently accessed data. Having your files into cloud storage will also give you the ability to share them with friends or co-workers.

Storage services enable developers to store data in the cloud, relying on authentication and other access features that control who can get to the data. If you need any information about getting started with Aspose.HTML Cloud, please refer to the Create an Account and Get Credentials article.

Examples of Working with Storage Files

This article provides a description of SDK and REST methods to manipulate files in the cloud storage, i.e. upload, download or delete files.

Example 1: Check if a file exists in the storage

The following example demonstrates how to check if a file exists in the storage.

Aspose.HTML Cloud for .NET API provides the FileExistsAsync() method that checks if a file specified by the path exists in the storage.

1// Initialize an SDK API object
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").StorageApi;
3
4// Check if a file exists in the storage
5var exists = await api.FileExistsAsync("/test.html");

Java

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5Call<ObjectExist> call = storageApi.objectExists("FolderInStorage/file.txt", null, null);
6
7Response<ObjectExist> res = call.execute();
8ObjectExist result = res.body();

C++

 1#include "AsposeHtmlCloud.h"
 2
 3const utility::string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
 4const utility::string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
 5const utility::string_t basePath = L"https://api.aspose.cloud/v4.0";
 6const utility::string_t authPath = L"https://api.aspose.cloud/connect/token";
 7
 8// Create configuration for authorization
 9std::shared_ptr<ApiConfiguration> apiConfig(new ApiConfiguration(clientId, clientSecret, basePath, authPath));
10
11// Create client from configuration
12std::shared_ptr<ApiClient> apiClient(new ApiClient(apiConfig));
13
14// Create StorageApi
15StorageApi* api = new StorageApi(apiClient);
16
17utility::string_t file = L"FolderInStorage/file.txt";
18boost::optional<utility::string_t> versionId = L"";
19boost::optional<utility::string_t> storageName = L"";
20
21auto result_exist = api->objectExists(file, versionId, storageName).get();
22
23bool isExist = result_exist->isExists();
24bool isFolder = result_exist->isFolder();
25
26delete api;

Python

 1configuration = Configuration(
 2    basePath="https://api.aspose.cloud/v4.0",
 3    authPath="https://api.aspose.cloud/connect/token",
 4    apiKey="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 5    appSid="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 6    debug=True)
 7
 8client = Client(configuration)
 9api = StorageApi(client)
10
11res = api.object_exists("fileInStorage.txt").to_dict()
12
13exist = res['exists']
14is_folder = res['is_folder']
15print(res)

PHP

 1$configuration = array(
 2    "basePath" => "https://api.aspose.cloud/v4.0",
 3    "authPath" => "https://api.aspose.cloud/connect/token",
 4    "apiKey" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 5    "appSID" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 6    "defaultUserAgent" => "Webkit"
 7);
 8
 9$api_stor = new StorageApi($configuration);
10
11// Path to the file
12$path = "FolderInStorage/file.txt";
13
14//Default storage
15$storage_name = null;
16
17//Last version
18$version_id = null;
19
20$result = $api_stor->objectExists($path, $storage_name, $version_id);
21
22$is_exist = $result->$result->getExists();
23$is_folder = $result->getIsFolder();

Ruby

 1# load the gem
 2require 'aspose_html_cloud'
 3
 4CONFIG = {
 5  "basePath": "https://api.aspose.cloud/v4.0",
 6  "authPath": "https://api.aspose.cloud/connect/token",
 7  "apiKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 8  "appSID": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 9  "debug": true
10}
11
12api = AsposeHtml::StorageApi.new CONFIG
13
14name = "test.txt"
15path = "FolderInStorage/" + name
16opts = {storage_name: nil, version_id: nil}
17
18res = api.object_exists(path, opts)
19
20exist = res.exists

Node.js

 1// Get keys from aspose site.
 2// There is free quota available.
 3// For more details, see https://purchase.aspose.cloud/pricing
 4	
 5var conf = {
 6    "basePath":"https://api.aspose.cloud/v4.0",
 7    "authPath":"https://api.aspose.cloud/connect/token",
 8    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 9    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
10    "defaultUserAgent":"NodeJsWebkit"
11};
12
13var api = require('@asposecloud/aspose-html-cloud');
14
15// Create Storage Api object
16var instance = new api.StorageApi(conf);
17
18var callback = function(error, data, response) {
19  if (error) {
20    console.error(error);
21  } else {
22    console.log(data);
23  }
24};
25
26var file = "folderInStorage/file.txt";
27var opts = {
28    'versionId': null,
29    'storageName': null
30};
31
32instance.objectExists(file, opts, callback);

Swift

 1import Alamofire
 2import Foundation
 3import XCTest
 4import AsposeHtmlCloud
 5
 6ClientAPI.setConfig(
 7	basePath: "https://api.aspose.cloud/v4.0",
 8	authPath: "https://api.aspose.cloud/connect/token",
 9	apiKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
10	appSID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
11	debugging: true
12)
13
14let expectation = self.expectation(description: "Test is not exist file")
15
16let not_exist_file = "non_exist.gif"
17
18StorageAPI.objectExists(path: not_exist_file, storageName: nil, versionId: nil) {(data, error) in
19    guard error == nil else {
20        XCTFail("Error objectExists not exist. Error=\(error!.localizedDescription)")
21        return
22    }
23    XCTAssertFalse(data!.exists)
24    XCTAssertFalse(data!.isFolder)
25    expectation.fulfill()
26}
27
28self.waitForExpectations(timeout: 100.0, handler: nil)

Java/Android

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5Call<ObjectExist> call = storageApi.objectExists("FolderInStorage/file.txt", null, null);
6
7Response<ObjectExist> res = call.execute();
8ObjectExist result = res.body();

CURL

1curl -X POST -v \
2	"https://api.aspose.cloud/v4.0/html/storage/exists?path=test.html&storageName=STORAGE_NAME" \
3    -H "Content-Type: application/json" \
4    -H "Authorization:Bearer <JWT_token>"

Example 2: Upload file from local file system to specified storage

The following example demonstrates how to upload a file by its local file system path to the specified storage.

1// Initialize an SDK API object
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").StorageApi;
3
4// Upload file test.html to "files" folder in the cloud storage
5var exists = await api.UploadFileAsync("test.html", "files/test.html", "STORAGE_NAME");

Java

 1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
 2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
 3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
 4
 5File f = new File("PathToFile", "test.txt");
 6RequestBody requestBody = RequestBody.create( MediaType.parse("multipart/form-data"), f);
 7MultipartBody.Part fileToUpload = MultipartBody.Part.createFormData("file", f.getName(), requestBody);
 8
 9Call<FilesUploadResult> call = storageApi.uploadFile(fileToUpload, "FolderInStorage", null);
10
11Response<FilesUploadResult> res = call.execute();
12FilesUploadResult result = res.body();

C++

 1#include "AsposeHtmlCloud.h"
 2
 3const utility::string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
 4const utility::string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
 5const utility::string_t basePath = L"https://api.aspose.cloud/v4.0";
 6const utility::string_t authPath = L"https://api.aspose.cloud/connect/token";
 7
 8// Create configuration for authorization
 9std::shared_ptr<ApiConfiguration> apiConfig(new ApiConfiguration(clientId, clientSecret, basePath, authPath));
10
11// Create client from configuration
12std::shared_ptr<ApiClient> apiClient(new ApiClient(apiConfig));
13
14// Create StorageApi
15StorageApi* api = new StorageApi(apiClient);
16
17const utility::string_t testSource = L"C:\\WORK\\TEST\\";
18const utility::string_t name = _XPLATSTR("test.jpg");
19std::shared_ptr<HttpContent> file(new HttpContent(testSource, name));
20
21utility::string_t folder = L"FolderInStorage";
22boost::optional<utility::string_t> storageName = L"";
23
24auto result = api->uploadFile(folder, file, storageName).get();
25
26bool isError = result->errorsIsSet();
27
28delete api;

Python

 1configuration = Configuration(
 2    basePath="https://api.aspose.cloud/v4.0",
 3    authPath="https://api.aspose.cloud/connect/token",
 4    apiKey="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 5    appSid="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 6    debug=True)
 7
 8client = Client(configuration)
 9api = StorageApi(client)
10
11result = api.upload_file("FolderInStorage", "full/path/to/the/file.txt")
12ok = len(result.uploaded) == 1 and len(result.errors) == 0

PHP

 1$configuration = array(
 2    "basePath" => "https://api.aspose.cloud/v4.0",
 3    "authPath" => "https://api.aspose.cloud/connect/token",
 4    "apiKey" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 5    "appSID" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 6    "defaultUserAgent" => "Webkit"
 7);
 8
 9$api_stor = new StorageApi($configuration);
10
11$file = new SplFileObject("full/path/to/the/file.txt");
12
13//Default storage
14$storage_name = null;
15
16$response = $api_stor->uploadFile("FolderInStorage", $file, $storage_name);
17
18$isOK = count($response->getUploaded()) == 1 && count($response->getErrors()) == 0

Ruby

 1# load the gem
 2require 'aspose_html_cloud'
 3
 4CONFIG = {
 5  "basePath": "https://api.aspose.cloud/v4.0",
 6  "authPath": "https://api.aspose.cloud/connect/token",
 7  "apiKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 8  "appSID": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 9  "debug": true
10}
11
12api = AsposeHtml::StorageApi.new CONFIG
13
14folder = "FolderInStorage"
15file = File.realpath('path/to/local/file.txt')
16
17opts = {storage_name: nil, version_id: nil}
18
19res = api.upload_file(folder, file, opts)
20
21isOk = res.uploaded.length == 1

Node.js

 1// Get keys from aspose site.
 2// There is free quota available.
 3// For more details, see https://purchase.aspose.cloud/pricing
 4
 5var conf = {
 6    "basePath":"https://api.aspose.cloud/v4.0",
 7    "authPath":"https://api.aspose.cloud/connect/token",
 8    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 9    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
10    "defaultUserAgent":"NodeJsWebkit"
11};
12
13var api = require('@asposecloud/aspose-html-cloud');
14
15// Create Storage Api object
16var instance = new api.StorageApi(conf);
17
18var callback = function(error, data, response) {
19  if (error) {
20    console.error(error);
21  } else {
22    console.log(data);
23  }
24};
25
26var folder = "FolderInStorage";
27var file = fs.createReadStream(path.normalize('path/to/loca;/file.txt'));
28var opts = { 'storageName': null };
29
30instance.uploadFile(folder, file, opts, callback);

Swift

 1import Alamofire
 2import Foundation
 3import XCTest
 4import AsposeHtmlCloud
 5
 6static let fm = FileManager.default
 7let resourceDir = fm.homeDirectoryForCurrentUser.appendingPathComponent("Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/Resources")
 8
 9func url(forResource fileName: String) -> URL {
10	return resourceDir.appendingPathComponent(fileName)
11}
12
13ClientAPI.setConfig(
14	basePath: "https://api.aspose.cloud/v4.0",
15	authPath: "https://api.aspose.cloud/connect/token",
16	apiKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
17	appSID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
18	debugging: true
19)
20
21let expectation = self.expectation(description: "Test is uploadFile")
22
23let fileName = "test.jpg"
24
25let urlTest = url(forResource: fileName)
26
27StorageAPI.uploadFile(file: urlTest, path: "HtmlTesting", storageName: nil) {(data, error) in
28    guard error == nil else {
29        XCTFail("Error uploadFile. Error=\(error!.localizedDescription)")
30        return
31    }
32
33    XCTAssertEqual(data!.uploaded!.count, 1)
34    XCTAssertEqual(data!.errors!.count, 0)
35
36    expectation.fulfill()
37}
38
39self.waitForExpectations(timeout: 100.0, handler: nil)

Java/Android

 1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
 2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
 3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
 4
 5File f = new File("PathToFile", "test.txt");
 6RequestBody requestBody = RequestBody.create( MediaType.parse("multipart/form-data"), f);
 7MultipartBody.Part fileToUpload = MultipartBody.Part.createFormData("file", f.getName(), requestBody);
 8
 9Call<FilesUploadResult> call_create = storageApi.uploadFile(fileToUpload, "FolderInStorage", null);
10
11Response<FilesUploadResult> res = call_create.execute();
12FilesUploadResult result = res.body();

CURL

1curl -X POST \
2	-v "https://api.aspose.cloud/v4.0/html/file?path=/files/test.html&storageName=MyStorage" \
3	--data-binary test.html \
4    -H "Authorization:Bearer <JWT_token>"

Example 3: Download file from cloud storage to local file system

The examples below show how to download a file from storage to the local file system using SDKs and REST API calls.

1// Initialize an SDK API object
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").StorageApi;
3
4// Download file test.html from cloud folder "files" to local file system
5var exists = await api.DownloadFileAsync("files/test.html", "test.html", "STORAGE_NAME");

Java

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5Call<ResponseBody> call = storageApi.downloadFile("FolderInStorage/fileInStorage.txt", null, null);
6
7Response<ResponseBody> res = call.execute();
8ResponseBody res_download = res.body();

C++

 1#include "AsposeHtmlCloud.h"
 2
 3const utility::string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
 4const utility::string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
 5const utility::string_t basePath = L"https://api.aspose.cloud/v4.0";
 6const utility::string_t authPath = L"https://api.aspose.cloud/connect/token";
 7
 8// Create configuration for authorization
 9std::shared_ptr<ApiConfiguration> apiConfig(new ApiConfiguration(clientId, clientSecret, basePath, authPath));
10
11// Create client from configuration
12std::shared_ptr<ApiClient> apiClient(new ApiClient(apiConfig));
13
14// Create StorageApi
15StorageApi* api = new StorageApi(apiClient);
16
17utility::string_t file = L"FolderInStorage/file.txt";
18boost::optional<utility::string_t> versionId = L"";
19boost::optional<utility::string_t> storageName = L"";
20
21auto result_download = api->downloadFile(file, versionId, storageName).get();
22
23utility::string_t save = L"PathToSave/testDowmloadFile.txt";
24std::ofstream saved_data(save, std::ios::out | std::ios::binary);
25
26//Save file locally
27if (saved_data.is_open()) 
28{
29	result_download.writeTo(saved_data);
30	saved_data.close();
31}
32else
33{
34	std::cout << "Unable to open file";
35}
36
37delete api;

Python

 1configuration = Configuration(
 2    basePath="https://api.aspose.cloud/v4.0",
 3    authPath="https://api.aspose.cloud/connect/token",
 4    apiKey="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 5    appSid="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 6    debug=True)
 7
 8client = Client(configuration)
 9api = StorageApi(client)
10
11result = api.download_file("PathInStorage/file.txt")
12copy2(result, "path/to/save/file.txt")
13os.remove(result)

PHP

 1$configuration = array(
 2    "basePath" => "https://api.aspose.cloud/v4.0",
 3    "authPath" => "https://api.aspose.cloud/connect/token",
 4    "apiKey" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 5    "appSID" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 6    "defaultUserAgent" => "Webkit"
 7);
 8
 9$api_stor = new StorageApi($configuration);
10
11// Default storage
12$storage_name = null;
13
14// Last version
15$version_id = null;
16
17$result = $api_stor->downloadFile("/FileInStorage/file.txt", $storage_name, $version_id);
18
19copy($result->getRealPath(), "/path/to/local/file.txt");

Ruby

 1# load the gem
 2require 'aspose_html_cloud'
 3
 4CONFIG = {
 5  "basePath": "https://api.aspose.cloud/v4.0",
 6  "authPath": "https://api.aspose.cloud/connect/token",
 7  "apiKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 8  "appSID": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 9  "debug": true
10}
11
12api = AsposeHtml::StorageApi.new CONFIG
13
14file = "FolderInStorage/file.txt"
15
16opts = {storage_name: nil, version_id: nil}
17
18res = api.download_file(file, opts)
19
20# save to a local disk
21FileUtils.mv(res.path, '/path/to/result/file.txt')

Node.js

 1// Get keys from aspose site.
 2// There is free quota available.
 3// For more details, see https://purchase.aspose.cloud/pricing
 4	
 5var conf = {
 6    "basePath":"https://api.aspose.cloud/v4.0",
 7    "authPath":"https://api.aspose.cloud/connect/token",
 8    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 9    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
10    "defaultUserAgent":"NodeJsWebkit"
11};
12
13var api = require('@asposecloud/aspose-html-cloud');
14
15// Create Storage Api object
16var instance = new api.StorageApi(conf);
17
18var callback = function(error, data, response) {
19  if (error) {
20    console.error(error);
21  } else {
22    console.log(data);
23  }
24};
25
26var options = {
27'versionId' : null, // last version
28'storageName': null // default storage
29};
30
31instance.downloadFile('path/to/file.txt' options, callback);

Swift

 1import Alamofire
 2import Foundation
 3import XCTest
 4import AsposeHtmlCloud
 5
 6ClientAPI.setConfig(
 7	basePath: "https://api.aspose.cloud/v4.0", 
 8	authPath: "https://api.aspose.cloud/connect/token", 
 9	apiKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", 
10	appSID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", 
11	debugging: true
12)
13
14static let fm = FileManager.default
15let resourceDir = fm.homeDirectoryForCurrentUser.appendingPathComponent("Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/Resources")
16let resultDir = fm.homeDirectoryForCurrentUser.appendingPathComponent("Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/TestResult")
17
18func url(forResource fileName: String) -> URL {
19	return resourceDir.appendingPathComponent(fileName)
20}
21
22func fileExist(name: String) -> Bool {
23	return FileManager.default.fileExists(atPath: name)
24}
25
26func saveFile(what data: Data?, fileName name: String) {
27    
28    let pathFile = resultDir.appendingPathComponent(name)
29
30    do{
31        _ = try data!.write(to: pathFile)
32    }catch{
33        print("Error save file.\(error)")
34    }
35}
36
37ClientAPI.setConfig(
38	basePath: "https://api.aspose.cloud/v4.0", 
39	authPath: "https://api.aspose.cloud/connect/token", 
40	apiKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", 
41	appSID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", 
42	debugging: true
43)
44
45let expectation = self.expectation(description: "Test download file")
46
47let fileName = "test.jpg"
48
49let urlTest = url(forResource: fileName)
50
51StorageAPI.uploadFile(file: urlTest, path: "/", storageName: nil) {(data, error) in
52    guard error == nil else {
53        XCTFail("Error uploadFile. Error=\(error!.localizedDescription)")
54        return
55    }
56    
57    XCTAssertEqual(data!.uploaded!.count, 1)
58    XCTAssertEqual(data!.errors!.count, 0)
59
60    StorageAPI.downloadFile(path: fileName, storageName: nil, versionId: nil) {(data, error) in
61        guard error == nil else {
62            XCTFail("Error download file. Error=\(error!.localizedDescription)")
63            return
64        }
65    
66        saveFile(what: data, fileName: "downloaded_file.jpg")
67        expectation.fulfill()
68    }
69}
70self.waitForExpectations(timeout: 300.0, handler: nil)

Java/Android

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5Call<ResponseBody> call = storageApi.downloadFile("FolderInStorage/fileInStorage.txt", null, null);
6
7Response<ResponseBody> res = call.execute();
8ResponseBody res_download = res.body();

CURL

1curl -X GET \
2	-v "https://api.aspose.cloud/v4.0/html/file?path=/files/test.html&storageName=MyStorage" \
3	--output test.html \
4    -H "Authorization:Bearer <JWT_token>"

Example 4: Delete a storage file by its path from the specified or default storage

1// Initialize an SDK API object
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").StorageApi;
3
4// Delete file test.html that is located in the cloud folder named "files"
5var exists = await api.DeleteFileAsync("files/test.html", "STORAGE_NAME");

Java

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5Call<ResponseBody> call = storageApi.deleteFile("FolderInStorage/fileInStorage.txt", null, null);
6
7Response<ResponseBody> res = call.execute();

C++

 1#include "AsposeHtmlCloud.h"
 2
 3const utility::string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
 4const utility::string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
 5const utility::string_t basePath = L"https://api.aspose.cloud/v4.0";
 6const utility::string_t authPath = L"https://api.aspose.cloud/connect/token";
 7
 8// Create configuration for authorization
 9std::shared_ptr<ApiConfiguration> apiConfig(new ApiConfiguration(clientId, clientSecret, basePath, authPath));
10
11// Create client from configuration
12std::shared_ptr<ApiClient> apiClient(new ApiClient(apiConfig));
13
14// Create StorageApi
15StorageApi* api = new StorageApi(apiClient);
16
17utility::string_t file = L"FolderInStorage/file.txt";
18boost::optional<utility::string_t> versionId = L"";
19boost::optional<utility::string_t> storageName = L"";
20
21auto result_delete = api->deleteFile(file, versionId, storageName).get();
22
23bool success = result_delete->getCode() == 200;
24
25delete api;

Python

 1configuration = Configuration(
 2    basePath="https://api.aspose.cloud/v4.0",
 3    authPath="https://api.aspose.cloud/connect/token",
 4    apiKey="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 5    appSid="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 6    debug=True)
 7
 8client = Client(configuration)
 9api = StorageApi(client)
10
11api.delete_file('FolderInStorage/file.txt')

PHP

 1$configuration = array(
 2    "basePath" => "https://api.aspose.cloud/v4.0",
 3    "authPath" => "https://api.aspose.cloud/connect/token",
 4    "apiKey" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 5    "appSID" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 6    "defaultUserAgent" => "Webkit"
 7);
 8
 9$api_stor = new StorageApi($configuration);
10
11// Default storage
12$storage_name = null;
13
14// Last version
15$version_id = null;
16
17$api_stor->deleteFile("FileInStorage.txt", $storage_name, $version_id);

Ruby

 1# load the gem
 2require 'aspose_html_cloud'
 3
 4CONFIG = {
 5  "basePath": "https://api.aspose.cloud/v4.0",
 6  "authPath": "https://api.aspose.cloud/connect/token",
 7  "apiKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 8  "appSID": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 9  "debug": true
10}
11
12api = AsposeHtml::StorageApi.new CONFIG
13
14file = "FolderInStorage/file.txt"
15
16opts = {storage_name: nil, version_id: nil}
17
18res = api.delete_file(file, opts)

Node.js

 1// Get keys from aspose site.
 2// There is free quota available.
 3// For more details, see https://purchase.aspose.cloud/pricing
 4	
 5var conf = {
 6    "basePath":"https://api.aspose.cloud/v4.0",
 7    "authPath":"https://api.aspose.cloud/connect/token",
 8    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 9    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
10    "defaultUserAgent":"NodeJsWebkit"
11};
12
13var api = require('@asposecloud/aspose-html-cloud');
14
15// Create Storage Api object
16var instance = new api.StorageApi(conf);
17
18var callback = function(error, data, response) {
19  if (error) {
20    console.error(error);
21  } else {
22    console.log(data);
23  }
24};
25
26var options = {
27'versionId' : null, // last version
28'storageName': null // default storage
29};
30
31instance.deleteFile('path/to/file.txt' options, callback);

Swift

 1import Alamofire
 2import Foundation
 3import XCTest
 4import AsposeHtmlCloud
 5
 6ClientAPI.setConfig(
 7	basePath: "https://api.aspose.cloud/v4.0",
 8	authPath: "https://api.aspose.cloud/connect/token",
 9	apiKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
10	appSID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
11	debugging: true
12)
13
14static let fm = FileManager.default
15let resourceDir = fm.homeDirectoryForCurrentUser.appendingPathComponent("Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/Resources")
16
17func url(forResource fileName: String) -> URL {
18	return resourceDir.appendingPathComponent(fileName)
19}
20
21let expectation = self.expectation(description: "Test delete file")
22
23let fileName = "test.jpg"
24
25let urlTest = url(forResource: fileName)
26
27    // Upload test file to storage
28StorageAPI.uploadFile(file: urlTest, path: "HtmlTesting", storageName: nil) {(data, error) in
29    guard error == nil else {
30        XCTFail("Error uploadFile. Error=\(error!.localizedDescription)")
31        return
32    }
33
34    XCTAssertEqual(data!.uploaded!.count, 1)
35    XCTAssertEqual(data!.errors!.count, 0)
36
37    StorageAPI.deleteFile(path: "HtmlTesting/\(fileName)") {(data, error) in
38        guard error == nil else {
39            XCTFail("Error delete file. Error=\(error!.localizedDescription)")
40            return
41        }
42        expectation.fulfill()
43    }
44}
45self.waitForExpectations(timeout: 100.0, handler: nil)

Java/Android

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5Call<ResponseBody> call = storageApi.deleteFile("FolderInStorage/fileInStorage.txt", null, null);
6
7Response<ResponseBody> res = call.execute();

CURL

1curl -X DELETE \
2	-v "https://api.aspose.cloud/v4.0/html/file?path=/files/test.html&storageName=MyStorage" \
3    -H "Authorization:Bearer <JWT_token>"

Install Aspose.HTML Cloud SDK for .NET via NuGet. Complete source code of Aspose.HTML SDK for .NET is freely available on the GitHub repository.

Aspose.HTML provides the Cloud SDK Family to access files and folders stored in the user associated Aspose Cloud Storage or any other Cloud Storage of your choice.

Working with Files in Storage – Aspose.HTML Cloud

Storage Files

Examples of Working with Storage Files

Example 1: Check if a file exists in the storage

Example 2: Upload file from local file system to specified storage

Example 3: Download file from cloud storage to local file system

Example 4: Delete a storage file by its path from the specified or default storage

See Also