nginstack

Class: FileStorage

@nginstack/web-framework/lib/file-storage/FileStorage~ FileStorage

new FileStorage(classKey)

Classe responsável por gerenciar os arquivos vinculados a cadastros definidos por meio da classe de dados "Relações entre Cadastros e Arquivos" (-1898141863).

Parameters:
Name Type Description
classKey number

Chave da classe de dados que define as relações entre cadastros e os arquivos. Deve ser uma classe filha de "Relações entre Cadastros e Arquivos" (-1898141863).

Methods

addFile(originalFileName, content, attributes)

Cria um arquivo que poderá ser posteriormente vinculado a um cadastro do sistema por meio do método #linkFile.

Parameters:
Name Type Description
originalFileName string

Nome original do arquivo. O nome que será gravado na Virtual File System é um nome único gerado a partir desse nome e dos atributos do arquivo.
content string | File | MemoryStream

Conteúdo do arquivo.
attributes Object

Atributos do arquivo.
Returns:

Chave do arquivo na Virtual File System.

Type
number

findFileByName(fileName)

Verifica se já existe um arquivo com o nome informado.

Parameters:
Name Type Description
fileName string

Nome do arquivo.
See:
Returns:

Informações do arquivo caso exista um com o nome informado ou null no caso contrário. Como o arquivo encontrado pode estar vinculado a vários registros, a propriedade FileInfo sempre será falso.

Type
FileInfo

findLinkedFiles(key, opt_filters)

Obtém as informações sobre os arquivos vinculados a chave informada.

Parameters:
Name Type Description
key number

Chave do registro do qual se deseja obter os arquivos vinculados.
opt_filters Object

Indica os filtros de obtenção das informações dos arquivos. Serão retornados apenas as informações dos arquivos cujo atributos satisfaçam todos os filtros informados.
See:
Returns:

Array de objetos contendo as informações de documentos

Type
Array.<FileInfo>

formatUniqueFileName(originalFileName, attributes)

Complementa o nome de um arquivo com os seus atributos a fim de torná-lo único dentro de um diretório da Virtual File System.

Parameters:
Name Type Description
originalFileName string

Nome original do arquivo.
attributes Object

Atributos do arquivo.
Returns:

Nome único do arquivo a ser utilizado no diretório de armazenagem na Virtual File System.

Type
string

getFileAttributes(fileKey)

Obtém os atributos extras do arquivo informado.

Parameters:
Name Type Description
fileKey number

Chave do documento.
Returns:

Atributos extras do arquivo.

Type
Object

linkFile(fileKey, recordKey)

Vincula uma chave de cadastro a um arquivo da Virtual File System.

Parameters:
Name Type Description
fileKey number

Chave do arquivo.
recordKey number

Chave do registro.

relationshipExists(fileKey, targetKey)

Verifica se já existe um vínculo entre o arquivo e a chave informada.

Parameters:
Name Type Description
fileKey number

Chave do documento.
targetKey number

Chave do registro possivelmente vinculado.
Returns:

True se existir um vínculo.

Type
boolean

updateFileAttributes(fileKey, attributes, opt_originalName)

Atualiza os atributos extras de um arquivo da Virtual File System.

Parameters:
Name Type Description
fileKey number

Chave do arquivo.
attributes Object

Atributos do arquivo.
opt_originalName string

Nome original do arquivo que foi carregado na Virtual File System.