Skip to content

Latest commit

 

History

History
155 lines (103 loc) · 5.83 KB

FileApi.md

File metadata and controls

155 lines (103 loc) · 5.83 KB

barcode\FileApi

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

Method HTTP request Description
CopyFile Put /barcode/storage/file/copy/{srcPath} Copy file
DeleteFile Delete /barcode/storage/file/{path} Delete file
DownloadFile Get /barcode/storage/file/{path} Download file
MoveFile Put /barcode/storage/file/move/{srcPath} Move file
UploadFile Put /barcode/storage/file/{path} Upload file

CopyFile

CopyFile(ctx, srcPath, destPath, optional) Copy file

CopyFile Required Parameters

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

CopyFile Optional Parameters

Optional parameters are passed through a pointer to a FileApiCopyFileOpts struct

Name Type Description Notes
SrcStorageName optional.String Source storage name
DestStorageName optional.String Destination storage name
VersionId optional.String File version ID to copy

CopyFile Return type

(empty response body)

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

DeleteFile

DeleteFile(ctx, path, optional) Delete file

DeleteFile Required Parameters

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

DeleteFile Optional Parameters

Optional parameters are passed through a pointer to a FileApiDeleteFileOpts struct

Name Type Description Notes
StorageName optional.String Storage name
VersionId optional.String File version ID to delete

DeleteFile Return type

(empty response body)

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

DownloadFile

*os.File DownloadFile(ctx, path, optional) Download file

DownloadFile Required Parameters

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

DownloadFile Optional Parameters

Optional parameters are passed through a pointer to a FileApiDownloadFileOpts struct

Name Type Description Notes
StorageName optional.String Storage name
VersionId optional.String File version ID to download

DownloadFile Return type

byte[]

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

MoveFile

MoveFile(ctx, srcPath, destPath, optional) Move file

MoveFile Required Parameters

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

MoveFile Optional Parameters

Optional parameters are passed through a pointer to a FileApiMoveFileOpts struct

Name Type Description Notes
SrcStorageName optional.String Source storage name
DestStorageName optional.String Destination storage name
VersionId optional.String File version ID to move

MoveFile Return type

(empty response body)

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

UploadFile

FilesUploadResult UploadFile(ctx, path, file, optional) Upload file

UploadFile Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
path string Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header.
file *os.File File to upload
optional *FileApiUploadFileOpts optional parameters nil if no parameters

UploadFile Optional Parameters

Optional parameters are passed through a pointer to a FileApiUploadFileOpts struct

Name Type Description Notes
StorageName optional.String Storage name

UploadFile Return type

FilesUploadResult

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