Class Files

Hierarchy

TagoIOModule<GenericModuleParams>
- Files

Index

Constructors

Methods

_addToQueue _completeMultipartUpload _uploadPart changePermission checkPermission copy delete getFileMD5 getFileURLSigned list move uploadBase64 uploadFile

Constructors

constructor

new Files(params): Files
Parameters
- params: GenericModuleParams
Returns Files
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:79

Methods

_addToQueue

_addToQueue(filename, uploadID, partNumber, blob, options?): Promise<{
ETag: string;
PartNumber: number;
}>
Adds an upload to the queue. It will try to upload for 'opts.maxTriesForEachChunk' and fail if it couldn't upload after those many tries.
Parameters
- filename: string
  
  the path + filename for the file
- uploadID: string
  
  the upload ID acquired by the 'createMultipartUpload' function call
- partNumber: number
- blob: Blob | Buffer
  
  the portion of the file to be uploaded
- Optional options: UploadOptions
  
  see the uploadFile function
Returns Promise<{
ETag: string;
PartNumber: number;
}>
- Defined in modules/Resources/Files.ts:282

_completeMultipartUpload

_completeMultipartUpload(filename, uploadID, parts, options?): Promise<{
file: string;
}>
Finishes a multipart upload instance
Parameters
- filename: string
  
  the path + filename for the file
- uploadID: string
  
  the upload ID acquired by the 'createMultipartUpload' function call
- parts: {
  ETag: String;
  PartNumber: number;
  }[]
  
  all the parts uploaded to the file
- Optional options: UploadOptions
  
  the upload options for this file
Returns Promise<{
file: string;
}>
- Defined in modules/Resources/Files.ts:320

_uploadPart

_uploadPart(filename, uploadID, partNumber, blob, options?): Promise<{
ETag: string;
PartNumber: number;
}>
Uploads a single part to TagoIO
Parameters
- filename: string
  
  the path + filename for the file
- uploadID: string
  
  the upload ID acquired by the 'createMultipartUpload' function call
- partNumber: number
  
  the sequential part number for the upload. This should be 1 in the first call, then 2 in the second call, so on and so forth
- blob: Blob | Buffer
  
  the portion of the file to be uploaded
- Optional options: UploadOptions
  
  the upload options for this file
Returns Promise<{
ETag: string;
PartNumber: number;
}>
- Defined in modules/Resources/Files.ts:231

changePermission

changePermission(filesVisibility): Promise<string>
Change visibility from files
Parameters
- filesVisibility: FilesPermission[]
  
  An Array with files and their visibility to be setted
Returns Promise<string>
- Defined in modules/Resources/Files.ts:141

checkPermission

checkPermission(file): Promise<{
public: boolean;
}>
Check if file is private or public
Parameters
- file: string
  
  Path of file
Returns Promise<{
public: boolean;
}>
- Defined in modules/Resources/Files.ts:125

copy

copy(fileList): Promise<string>
Copy Files
Parameters
- fileList: CopyFiles[]
  
  Array of copy actions to be made
Returns Promise<string>
Example
```
fileList: [
  {
    from: "/myfiles/myOldName.ext",
    to: "/myfiles/newFolder/andNewName.ext"
  }
]
```
- Defined in modules/Resources/Files.ts:97

delete

delete(files): Promise<string>
Delete Folder or Files
Parameters
- files: string[]
  
  An array of files or folders to be deleted
Returns Promise<string>
- Defined in modules/Resources/Files.ts:111

getFileMD5

getFileMD5(url): Promise<string>
Get file md5 with authenticate token for privates files
Parameters
- url: string
  
  Full TagoIO File url
Returns Promise<string>
- Defined in modules/Resources/Files.ts:183

getFileURLSigned

getFileURLSigned(url): Promise<string>
Get a file url with authenticate token valid for 120 seconds
Parameters
- url: string
  
  Full TagoIO File url
Returns Promise<string>
- Defined in modules/Resources/Files.ts:165

list

list(queryObj?): Promise<FileListInfo>
list of files in account
Parameters
- Optional queryObj: FileQuery
  
  Object with path, pagination and quantity
Returns Promise<FileListInfo>
- Defined in modules/Resources/Files.ts:21

move

move(fileList): Promise<string>
Move/Rename Files
Parameters
- fileList: MoveFiles[]
  
  Array move actions to be made
Returns Promise<string>
Example
```
fileList: [
  {
    from: "/myfiles/myOldName.ext",
    to: "/myfiles/newFolder/andNewName.ext"
  }
]
```
- Defined in modules/Resources/Files.ts:74

uploadBase64

uploadBase64(fileList): Promise<string>
Upload an array of files(Base64) to TagoIO The filename parameter is also full path
Parameters
- fileList: Base64File[]
  
  Array of files data to be uploaded
Returns Promise<string>
Example
```
fileList: [
  {
    filename: "/myfiles/myfile.ext",
    file: "StringWithBase64"
  }
]
```
- Defined in modules/Resources/Files.ts:51

uploadFile

uploadFile(file, filename, options?): Promise<{
file: string;
}>
Uploads a single file to TagoIO. The upload is multipart, meaning that the file will be divided and sent in chunks, resulting in multiple requests being made.
Parameters
- file: Blob | Buffer
  
  the file to be uploaded
- filename: string
  
  the path + filename for the file
- Optional options: UploadOptions
  
  the upload options for this file
Returns Promise<{
file: string;
}>
- Defined in modules/Resources/Files.ts:357

Class Files

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

params: GenericModuleParams

Returns Files

Methods

_addToQueue

Parameters

filename: string

uploadID: string

partNumber: number

blob: Blob | Buffer

Optional options: UploadOptions

Returns Promise<{ ETag: string; PartNumber: number; }>

_completeMultipartUpload

Parameters

filename: string

uploadID: string

parts: { ETag: String; PartNumber: number; }[]

Optional options: UploadOptions

Returns Promise<{ file: string; }>

_uploadPart

Parameters

filename: string

uploadID: string

partNumber: number

blob: Blob | Buffer

Optional options: UploadOptions

Returns Promise<{ ETag: string; PartNumber: number; }>

changePermission

Parameters

filesVisibility: FilesPermission[]

Returns Promise<string>

checkPermission

Parameters

file: string

Returns Promise<{ public: boolean; }>

copy

Parameters

fileList: CopyFiles[]

Returns Promise<string>

Example

delete

Parameters

files: string[]

Returns Promise<string>

getFileMD5

Parameters

url: string

Returns Promise<string>

getFileURLSigned

Parameters

url: string

Returns Promise<string>

list

Parameters

Optional queryObj: FileQuery

Returns Promise<FileListInfo>

move

Parameters

fileList: MoveFiles[]

Returns Promise<string>

Example

uploadBase64

Parameters

fileList: Base64File[]

Returns Promise<string>

Example

uploadFile

Parameters

file: Blob | Buffer

filename: string

Optional options: UploadOptions

Returns Promise<{ file: string; }>

Settings

`Optional` options: UploadOptions

Returns Promise<{
ETag: string;
PartNumber: number;
}>

parts: {
ETag: String;
PartNumber: number;
}[]

`Optional` options: UploadOptions

Returns Promise<{
file: string;
}>

`Optional` options: UploadOptions

Returns Promise<{
ETag: string;
PartNumber: number;
}>

Returns Promise<{
public: boolean;
}>

`Optional` queryObj: FileQuery

`Optional` options: UploadOptions

Returns Promise<{
file: string;
}>