nginstack

Class: UploadedFile

@nginstack/web-framework/lib/file-loader/UploadedFile~ UploadedFile

new UploadedFile()

Classe que representa o arquivo recebido em uma operação de upload de arquivos.

Extends

  • LoadedFile

Methods

move(filePath)

Move o arquivo recebido para o caminho especificado. O caminho deverá especificar o diretório e o nome do arquivo no destino.

Parameters:
Name Type Description
filePath string

Nome do arquivo destino.
Returns:

True se o arquivo foi movido com sucesso. Um arquivo não poderá ser movido mais de uma vez.

Type
boolean

toBytes()

Retorna os bytes do arquivo como um Uint8Array.

O uso deste método é limitado a arquivos com tamanho máximo de 16MiB. Para arquivos maiores deve ser utilizado o método move para mover o conteúdo para um arquivo temporário para que ele possa ser lido em blocos menores de dados.

Returns:
Type
Uint8Array

toText( [encoding])

Retorna o conteúdo do arquivo como texto.

O uso deste método é limitado a arquivos com tamanho máximo de 16MiB. Para arquivos maiores deve ser utilizado o método move para mover o conteúdo para um arquivo temporário para que ele possa ser lido em blocos menores de dados.

Parameters:
Name Type Argument Description
encoding string <optional>

Codificação a ser utilizada na leitura do arquivo. Se não for informada, será considerada a codificação 'utf-8'.
Returns:
Type
string

uploadToLobStorage(classKey [, options])

Grava o arquivo recebido na LobStorage.

Parameters:
Name Type Argument Description
classKey number | DBKey

Chave da classe filha de "/Dados/Sistema/Large Objects" onde serão gravados os dados.
options Object <optional>

Opções da operação de upload.

Properties
Name Type Argument Description
name string <optional>

Nome do arquivo a ser gravado na LobStorage. Caso não seja informado, será gerado um a partir do nome do arquivo original.
key number <optional>

Chave do arquivo a ser atualizado na LobStorage. Caso não seja informada, será criado um novo arquivo.
Returns:

Chave do arquivo criado ou atualizado.

Type
number
Example
this.button('Anexar imagens na LobStorage', function (bt) {
   const process = bt.process;
   process.upload({
     maxFiles: 20,
     accept: 'image/*'
   }).then(function (files) {
     files.forEach(function (file) {
       file.uploadToLobStorage(classKey);
     });
   }).catch(function (reason) {
     process.alert(reason);
   });
 });

uploadToVfs(directory [, options])

Grava o arquivo recebido na Virtual File System.

Parameters:
Name Type Argument Description
directory string | number

Diretório onde deverá ser gravado o arquivo.
options Object <optional>

Opções da operação de upload.

Properties
Name Type Argument Description
name string <optional>

Nome do arquivo a ser gravado na Virtual File System. Caso não seja informado, será gerado um a partir do nome do arquivo original.
key number <optional>

Chave do arquivo a ser atualizado na Virtual File System. A chave indicada deve existir no diretório directory. Caso não seja informada, será criado um novo arquivo.
Returns:

Chave do arquivo criado ou atualizado.

Type
number
Example
this.button('Anexar imagens na VFS', function (bt) {
   const process = bt.process;
   process.upload({
     maxFiles: 20,
     accept: 'image/*'
   }).then(function (files) {
     files.forEach(function (file) {
       file.uploadToVfs('/web-site/images');
     });
   }).catch(function (reason) {
     process.alert(reason);
   });
 });