Class: FileLoader

Methods

---

authorizeDownload(files, options)

Autoriza o download de um ou vários arquivo e retorna um id único que identifica essa autorização.

Parameters:

Name	Type	Description
files	string | number | DBKey | Array.<(string|number|DBKey)>	Arquivos para download.
options	DownloadOptions | Record.<*, *>	Opções da operação de download.

See:

• module:@nginstack/web-framework/lib/file-loader/DownloadOptions

Returns:

Id único que identificará essa operação de download no método #tryGetDownloadFile.

Type

string

---

authorizeUpload(options)

Autoriza o upload de um ou vários arquivo e retorna um id único que identifica essa autorização.

Parameters:

Name	Type	Description
options	UploadOptions | Record.<*, *>	Operações do upload.

See:

• module:@nginstack/web-framework/lib/file-loader/UploadOptions

Returns:

Id único que identificará essa operação de upload nos métodos #handleUploadRequest e #deleteUploadedFile. Este token deverá ser submetido para o script

Type

string

---

deleteUploadedFile(uploadId, fileId)

Exclui um arquivo enviado anteriormente em uma operação de upload.

Parameters:

Name	Type	Description
uploadId	string	Identificador único da operação de upload.
fileId	string	Identificador único do arquivo a ser removido.

Returns:

True se o arquivo existir e se for excluído com sucesso. False caso o arquivo não exista.

Type

boolean

---

getUploadedFiles(uploadId)

Obtém todos os arquivos enviados pelo cliente em uma operação de upload.

Parameters:

Name	Type	Description
uploadId	string	Identificador único da operação de upload da qual se deseja obter os arquivos.

See:

• module:@nginstack/web-framework/lib/file-loader/UploadedFile

Returns:

Array com objetos que permitem acesso aos arquivos recebidos.

Type

Array.<UploadedFile>

---

handleUploadRequest(uploadId, request)

Trata uma requisição de upload, gravando no servidor os arquivos enviados pelo cliente.

Parameters:

Name	Type	Description
uploadId	string	Id único que identifica a operação de upload.
request	Request	Requisição HTTP que deverá ser tratada.

Returns:

Arquivos gravados no servidor.

Type

Array.<FileInfoUpload>

---

purgeExpiredFiles()

Remove os arquivos temporários das operação de download e upload que ultrapassam o tempo de expiração.

---

tryGetDownloadFile(downloadId)

Obtém uma instância de DownloadFile com os dados do arquivo a ser descarregado.

Parameters:

Name	Type	Description
downloadId	string	Identificador único da operação de download da qual se deseja obter o arquivo.

See:

• module:@nginstack/web-framework/lib/file-loader/DownloadFile

Returns:

Objeto que permite acesso ao arquivo para download ou null caso o identificador informado seja inválido.

Type

DownloadFile