Skip to content

Latest commit

 

History

History
244 lines (169 loc) · 6.83 KB

FolderApi.md

File metadata and controls

244 lines (169 loc) · 6.83 KB
Raw

aspose_barcode_cloud.api.FolderApi

Load the API package

import 'package:aspose_barcode_cloud/aspose_barcode_cloud.dart';

All URIs are relative to https://api.aspose.cloud/v3.0

Method HTTP request Description
copyFolder PUT /barcode/storage/folder/copy/{srcPath} Copy folder
createFolder PUT /barcode/storage/folder/{path} Create the folder
deleteFolder DELETE /barcode/storage/folder/{path} Delete folder
getFilesList GET /barcode/storage/folder/{path} Get all files and folders within a folder
moveFolder PUT /barcode/storage/folder/move/{srcPath} Move folder

copyFolder

copyFolder(srcPath, destPath, srcStorageName, destStorageName)

Copy folder

Example

import 'package:aspose_barcode_cloud/aspose_barcode_cloud.dart';
// TODO Configure OAuth2 access token for authorization: JWT
//aspose_barcode_cloud.api.Configuration.accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = FolderApi();
final srcPath = srcPath_example; // String | Source folder path e.g. '/src'
final destPath = destPath_example; // String | Destination folder path e.g. '/dst'
final srcStorageName = srcStorageName_example; // String | Source storage name
final destStorageName = destStorageName_example; // String | Destination storage name

try {
    api_instance.copyFolder(srcPath, destPath, srcStorageName, destStorageName);
} catch (e) {
    print("Exception when calling FolderApi->copyFolder: $e\n");
}

Parameters

Name Type Description Notes
srcPath String Source folder path e.g. '/src'
destPath String Destination folder path e.g. '/dst'
srcStorageName String Source storage name [optional]
destStorageName String Destination storage name [optional]

Return type

void (empty response body)

Authorization

JWT

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createFolder

createFolder(path, storageName)

Create the folder

Example

import 'package:aspose_barcode_cloud/aspose_barcode_cloud.dart';
// TODO Configure OAuth2 access token for authorization: JWT
//aspose_barcode_cloud.api.Configuration.accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = FolderApi();
final path = path_example; // String | Folder path to create e.g. 'folder_1/folder_2/'
final storageName = storageName_example; // String | Storage name

try {
    api_instance.createFolder(path, storageName);
} catch (e) {
    print("Exception when calling FolderApi->createFolder: $e\n");
}

Parameters

Name Type Description Notes
path String Folder path to create e.g. 'folder_1/folder_2/'
storageName String Storage name [optional]

Return type

void (empty response body)

Authorization

JWT

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteFolder

deleteFolder(path, storageName, recursive)

Delete folder

Example

import 'package:aspose_barcode_cloud/aspose_barcode_cloud.dart';
// TODO Configure OAuth2 access token for authorization: JWT
//aspose_barcode_cloud.api.Configuration.accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = FolderApi();
final path = path_example; // String | Folder path e.g. '/folder'
final storageName = storageName_example; // String | Storage name
final recursive = true; // bool | Enable to delete folders, subfolders and files

try {
    api_instance.deleteFolder(path, storageName, recursive);
} catch (e) {
    print("Exception when calling FolderApi->deleteFolder: $e\n");
}

Parameters

Name Type Description Notes
path String Folder path e.g. '/folder'
storageName String Storage name [optional]
recursive bool Enable to delete folders, subfolders and files [optional] [default to false]

Return type

void (empty response body)

Authorization

JWT

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getFilesList

FilesList getFilesList(path, storageName)

Get all files and folders within a folder

Example

import 'package:aspose_barcode_cloud/aspose_barcode_cloud.dart';
// TODO Configure OAuth2 access token for authorization: JWT
//aspose_barcode_cloud.api.Configuration.accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = FolderApi();
final path = path_example; // String | Folder path e.g. '/folder'
final storageName = storageName_example; // String | Storage name

try {
    final result = api_instance.getFilesList(path, storageName);
    print(result);
} catch (e) {
    print("Exception when calling FolderApi->getFilesList: $e\n");
}

Parameters

Name Type Description Notes
path String Folder path e.g. '/folder'
storageName String Storage name [optional]

Return type

FilesList

Authorization

JWT

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

moveFolder

moveFolder(srcPath, destPath, srcStorageName, destStorageName)

Move folder

Example

import 'package:aspose_barcode_cloud/aspose_barcode_cloud.dart';
// TODO Configure OAuth2 access token for authorization: JWT
//aspose_barcode_cloud.api.Configuration.accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = FolderApi();
final srcPath = srcPath_example; // String | Folder path to move e.g. '/folder'
final destPath = destPath_example; // String | Destination folder path to move to e.g '/dst'
final srcStorageName = srcStorageName_example; // String | Source storage name
final destStorageName = destStorageName_example; // String | Destination storage name

try {
    api_instance.moveFolder(srcPath, destPath, srcStorageName, destStorageName);
} catch (e) {
    print("Exception when calling FolderApi->moveFolder: $e\n");
}

Parameters

Name Type Description Notes
srcPath String Folder path to move e.g. '/folder'
destPath String Destination folder path to move to e.g '/dst'
srcStorageName String Source storage name [optional]
destStorageName String Destination storage name [optional]

Return type

void (empty response body)

Authorization

JWT

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json