upload

Carregar arquivo para o armazenamento em nuvem do oneentry.

Descrição

Este método carrega um arquivo para um armazenamento de arquivos em nuvem. Passe para a data o valor obtido do tipo de entrada "file". Ele retorna uma Promise que resolve para um objeto IUploadingReturn[].

Os dados são um objeto de arquivo (ou array), saiba mais - Objeto File

FileUploading.upload(

file, fileQuery, fileQuery.type, fileQuery.entity, fileQuery.id, fileQuery.width, fileQuery.height, fileQuery.compress

);

Esquema de parâmetros

Esquema

file(obrigatório): File | Blob
Arquivo a ser carregado
exemplo: new File(["content"], "file.png", {"type": "image/png"})

fileQuery: IUploadingQuery
Conjunto opcional de parâmetros de consulta
exemplo:

{
  "type": "page",
  "entity": "editor",
  "id": 3787,
  "width": 0,
  "height": 0,
  "compress": true,
  "template": 1
}

fileQuery.type(obrigatório): string
Tipo, determina o nome da pasta no armazenamento.
exemplo: "page"

fileQuery.entity(obrigatório): string
Nome da entidade da qual o arquivo é carregado, determina o nome da pasta no armazenamento.
exemplo: "editor"

fileQuery.id(obrigatório): number
Identificador do objeto do qual o arquivo é carregado, determina o nome da pasta no armazenamento.
exemplo: 3787

fileQuery.width: number
Parâmetro de largura.
exemplo: 0

fileQuery.height: number
Parâmetro de altura.
exemplo: 0

fileQuery.compress: boolean
Flag de otimização (compressão) para imagens.
exemplo: true

Exemplos

Exemplo mínimo

const fileQuery = {
"type": "page",
"entity": "editor",
"id": 3787,
"width": 0,
"height": 0,
"compress": true
}
const response = await FileUploading.upload(file, fileQuery);

Exemplo de resposta

[
  {
    "filename": "files/project/page/3492/editor/e8afbd98-37a1-4123-bbeb-84118eaeecf1.md",
    "downloadLink": "https://stage.oneentry.cloud/cloud-static/files/project/page/3492/editor/e8afbd98-37a1-4123-bbeb-84118eaeecf1.md",
    "size": 4463
  }
]

Esquema de resposta

Esquema: IUploadingReturn[]

filename: string
Nome do arquivo com caminho relativo.
exemplo: "uploads/file.png"

downloadLink: string
Link para download do arquivo.
exemplo: "https://example.com/uploads/file.png"

size: number
Tamanho do arquivo em bytes.
exemplo: 1024

---