S3ProviderDelegate Interface

Hierarchy

S3ProviderDelegate

Index

Methods

Methods

Optional copyFileParams

copyFileParams(file: File, params: S3CopyParams): Promise<S3CopyParams>

- Defined in provider-s3/src/types/S3ProviderDelegate.ts:21
Customize parameters sent with COPY requests

Parameters
- file: File
- params: S3CopyParams
Returns Promise<S3CopyParams>

Optional deleteFileParams

deleteFileParams(file: File, params: S3DeleteParams): Promise<S3DeleteParams>

- Defined in provider-s3/src/types/S3ProviderDelegate.ts:26
Customize parameters sent with DELETE requests

Parameters
- file: File
- params: S3DeleteParams
Returns Promise<S3DeleteParams>

Optional getFileParams

getFileParams(file: File, params: S3GetParams): Promise<S3GetParams>

- Defined in provider-s3/src/types/S3ProviderDelegate.ts:31
Customize parameters sent with GET requests

Parameters
- file: File
- params: S3GetParams
Returns Promise<S3GetParams>

Optional listFilesParams

listFilesParams(params: S3ListParams): Promise<S3ListParams>

- Defined in provider-s3/src/types/S3ProviderDelegate.ts:16
Customize parameters sent with list requests

remarks

The provider will always list all files in the root. The MaxKeys option determines how many objects are returned PER BATCH, NOT TOTAL.

Parameters
- params: S3ListParams
Returns Promise<S3ListParams>

Optional putFileParams

putFileParams(file: File, params: S3PutParams): Promise<S3PutParams>

- Defined in provider-s3/src/types/S3ProviderDelegate.ts:36
Customize parameters sent with PUT requests

Parameters
- file: File
- params: S3PutParams
Returns Promise<S3PutParams>

Optional targetFileKey

targetFileKey(file: File): Promise<string>

- Defined in provider-s3/src/types/S3ProviderDelegate.ts:41
Return an alternate Key to compare origin file with differently named target file

Parameters
- file: File
Returns Promise<string>

Generated using TypeDoc