Working with Folders in Storage – Aspose.HTML Cloud

Working with Folders

Aspose.HTML Cloud allows you to work with files and folders in cloud storage. The most common storage use cases are cloud backup, disaster recovery, and archiving infrequently accessed data.

Aspose.HTML Cloud v4.0 allows you to work with and manipulate folders in cloud storage and provides the ability to use its functionality either directly through the REST API or through a set of wrappers implemented as SDKs for various programming languages, such as Python, PHP, Java/Android, Swift, C#, Node.js, and Ruby.

Examples of Working with Folders in Storage

Example 1. Check if a directory exists in storage

The examples below demonstrate how to check if a directory exists in the storage. The directory is specified by a path and the storage is specified by the storage name.

1// Initialize an SDK API object 
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").StorageApi;
3
4// Check if "files" directory exists
5var exists = await api.DirectoryExistsAsync("/files", "STORAGE_NAME");

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";
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("FolderInStorage").to_dict()
12print(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//Default storage
12$storage_name = null;
13
14//Last version
15$version_id = null;
16
17$result = $api_stor->objectExists("FolderInStorage", $storage_name, $version_id);
18
19$is_exist = $result->getExists() && $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
14dir = "FolderInStorage"
15
16opts = {storage_name: nil, version_id: nil}
17
18res = api.object_exists(dir, opts)
19
20exist = res.exists && res.is_folder

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.objectExists('FolderInStorage' 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
14let expectation = self.expectation(description: "Test is exist folder")
15
16let exist_folder = "HtmlTesting"
17
18StorageAPI.objectExists(path: exist_folder, storageName: nil, versionId: nil) {(data, error) in
19    guard error == nil else {
20        XCTFail("Error objectExists exist. Error=\(error!.localizedDescription)")
21        return
22    }
23
24    XCTAssertTrue(data!.exists)
25    XCTAssertTrue(data!.isFolder)
26    expectation.fulfill()
27}
28
29self.waitForExpectations(timeout: testTimeout, 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

1/storage/exists?path={path}&storageName={storageName}

Parameters:

Name	Description	Passed in	Required
path	Folder path	Query	+
storageName	Storage name or default storage if not specified.	Query	-

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

Example 2: Create a directory in specified or default storage

The examples below demonstrate how to create a directory in the storage. All parent directories specified in the directory Uri path will be created too if they don’t exist.

1// Initialize an SDK API object
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").StorageApi;
3
4// Create directory "files" in the cloud storage
5var exists = await api.CreateDirectoryAsync("/files", "STORAGE_NAME");

Java

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5String folderName = "CreateTestFolder";
6Call<Void> call = storageApi.createFolder(folderName, null);
7
8Response<Void> 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 path = L"HtmlTestDoc/TestFolder";
18boost::optional<utility::string_t> storageName = L"";
19
20auto result = api->createFolder(path, storageName).get();
21
22bool isOk = result->getCode() == 200;
23
24delete 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.create_folder("FolderName")

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//If status code != 200 throw exception
15$api_stor->createFolder("TestCreateFolder", $storage_name);

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
14dir = "HtmlTestDoc/testFolder1/testFolder2/testFolder3"
15
16opts_folder = {storage_name: nil}
17
18res = api.create_folder(dir, opts_folder)

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 path = "HtmlTestDoc/New_Folder";
27var opts = { 'storageName': null };
28
29instance.createFolder(path, 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 create folder")
15
16StorageAPI.createFolder(path: "HtmlTesting/TestCreateFolder", storageName: nil) {(data, error) in
17    guard error == nil else {
18        XCTFail("Error create folder. Error=\(error!.localizedDescription)")
19        return
20    }
21    expectation.fulfill()
22}
23self.waitForExpectations(timeout: testTimeout, handler: nil)

Java/Android

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5String folderName = "CreateTestFolder";
6Call<Void> call = storageApi.createFolder(folderName, null);
7
8Response<Void> res = call.execute();

CURL

cURL POST request: create a folder.

1/folder?path={path}&storageName={storageName}

Parameters:

Name	Description	Passed in	Required
path	Folder path to be created.	Query	+
storageName	Storage name or default storage if not specified.	Query	-

1curl -X POST \
2	-v "https://api.aspose.cloud/v4.0/html/folder?path=/files" \
3	-H "Content-Length:0" \
4    -H "Authorization:Bearer <JWT_token>"

Example 3: Delete a directory by a specified path from specified or default storage

1// Initialize an SDK API object
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").StorageApi;
3
4// Delete "files" directory in the storage
5var exists = await api.DeleteDirectoryAsync("/files", "STORAGE_NAME");

Java

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5String folderName = "DeletingFolder";
6
7//Create remote folder
8Call<Void> call = storageApi.deleteFolder(folderName, null, true)
9Response<Void> 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 folder_name = L"HtmlTestDoc/TestDeleteFolder";
18boost::optional<utility::string_t> storageName = L"";
19boost::optional<bool> recursive = true;
20
21//Delete folder
22auto result_del = api->deleteFolder(folder_name, storageName, recursive).get();
23
24bool isOk = result_del->getCode() == 200;
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
11api.delete_folder("FolderName")

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 = "FolderForDeleteInTheStorage";
12
13// Default storage
14$storage_name = null;
15
16// Delete all file and subfolders
17$recursive = true;
18
19$api_stor->deleteFolder($path, $storage_name, $recursive);

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
14dir = "FolderInStorage"
15
16opts_folder = {storage_name: nil}
17
18res = api.delete_folder(dir, opts_folder)

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 path = "HtmlTestDoc/New_Folder";
27var opts = { 'storageName': null };
28
29instance.deleteFolder(path, 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 delete folder")
15
16StorageAPI.deleteFolder(path: "HtmlTesting/TestDeleteFolder", storageName: nil, recursive: true) {(data, error) in
17    guard error == nil else {
18        XCTFail("Error delete folder. Error=\(error!.localizedDescription)")
19        return
20    }
21    expectation.fulfill()
22}
23self.waitForExpectations(timeout: testTimeout, handler: nil)

Java/Android

1Configuration.setAPI_KEY("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
2Configuration.setAPP_SID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
3StorageApi storageApi = new ApiClient().createService(StorageApi.class);
4
5String folderName = "DeletingFolder";
6
7//Create remote folder
8Call<Void> call = storageApi.deleteFolder(folderName, null, true)
9Response<Void> res = call.execute();

CURL

DELETE: delete the specified folder.

1/folder?path={path}&storageName={storageName}

Parameters:

Name	Description	Passed in	Required
path	Folder path to be deleted.	Query	+
storageName	Storage name or default storage if not specified.	Query	-

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

Working with Folders in Storage – Aspose.HTML Cloud

Working with Folders

Examples of Working with Folders in Storage

Example 1. Check if a directory exists in storage

Example 2: Create a directory in specified or default storage

Example 3: Delete a directory by a specified path from specified or default storage

See Also