Skip to content

Latest commit

 

History

History
151 lines (99 loc) · 5.63 KB

FolderApi.md

File metadata and controls

151 lines (99 loc) · 5.63 KB
Raw

barcode\FolderApi

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(ctx, srcPath, destPath, optional) Copy folder

CopyFolder Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
srcPath string Source folder path e.g. '/src'
destPath string Destination folder path e.g. '/dst'
optional *FolderApiCopyFolderOpts optional parameters nil if no parameters

CopyFolder Optional Parameters

Optional parameters are passed through a pointer to a FolderApiCopyFolderOpts struct

Name Type Description Notes
SrcStorageName optional.String Source storage name
DestStorageName optional.String Destination storage name

CopyFolder Return type

(empty response body)

[Back to API list] [Back to Model list] [Back to README]

CreateFolder

CreateFolder(ctx, path, optional) Create the folder

CreateFolder Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
path string Folder path to create e.g. 'folder_1/folder_2/'
optional *FolderApiCreateFolderOpts optional parameters nil if no parameters

CreateFolder Optional Parameters

Optional parameters are passed through a pointer to a FolderApiCreateFolderOpts struct

Name Type Description Notes
StorageName optional.String Storage name

CreateFolder Return type

(empty response body)

[Back to API list] [Back to Model list] [Back to README]

DeleteFolder

DeleteFolder(ctx, path, optional) Delete folder

DeleteFolder Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
path string Folder path e.g. '/folder'
optional *FolderApiDeleteFolderOpts optional parameters nil if no parameters

DeleteFolder Optional Parameters

Optional parameters are passed through a pointer to a FolderApiDeleteFolderOpts struct

Name Type Description Notes
StorageName optional.String Storage name
Recursive optional.Bool Enable to delete folders, subfolders and files [default to false]

DeleteFolder Return type

(empty response body)

[Back to API list] [Back to Model list] [Back to README]

GetFilesList

FilesList GetFilesList(ctx, path, optional) Get all files and folders within a folder

GetFilesList Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
path string Folder path e.g. '/folder'
optional *FolderApiGetFilesListOpts optional parameters nil if no parameters

GetFilesList Optional Parameters

Optional parameters are passed through a pointer to a FolderApiGetFilesListOpts struct

Name Type Description Notes
StorageName optional.String Storage name

GetFilesList Return type

FilesList

[Back to API list] [Back to Model list] [Back to README]

MoveFolder

MoveFolder(ctx, srcPath, destPath, optional) Move folder

MoveFolder Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
srcPath string Folder path to move e.g. '/folder'
destPath string Destination folder path to move to e.g '/dst'
optional *FolderApiMoveFolderOpts optional parameters nil if no parameters

MoveFolder Optional Parameters

Optional parameters are passed through a pointer to a FolderApiMoveFolderOpts struct

Name Type Description Notes
SrcStorageName optional.String Source storage name
DestStorageName optional.String Destination storage name

MoveFolder Return type

(empty response body)

[Back to API list] [Back to Model list] [Back to README]