subir

Sube un archivo al almacenamiento en la nube de oneentry.

Descripción

Este método sube un archivo a un almacenamiento de archivos en la nube. Pasa al método el valor obtenido del tipo de entrada "file". Devuelve una Promesa que se resuelve en un objeto IUploadingReturn[].

Los datos son un objeto de archivo (o un array), aprende más - Objeto File

FileUploading.upload(

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

);

Esquema de parámetros

Esquema

file(requerido): File | Blob
Archivo a subir
ejemplo: new File(["content"], "file.png", {"type": "image/png"})

fileQuery: IUploadingQuery
Conjunto opcional de parámetros de consulta
ejemplo:

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

fileQuery.type(requerido): string
Tipo, determina el nombre de la carpeta en el almacenamiento.
ejemplo: "page"

fileQuery.entity(requerido): string
Nombre de la entidad desde la cual se sube el archivo, determina el nombre de la carpeta en el almacenamiento.
ejemplo: "editor"

fileQuery.id(requerido): number
Identificador del objeto desde el cual se sube el archivo, determina el nombre de la carpeta en el almacenamiento.
ejemplo: 3787

fileQuery.width: number
Parámetro de ancho.
ejemplo: 0

fileQuery.height: number
Parámetro de altura.
ejemplo: 0

fileQuery.compress: boolean
Bandera de optimización (compresión) para imágenes.
ejemplo: true

Ejemplos

Ejemplo mínimo

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

Ejemplo de respuesta

[
  {
    "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 respuesta

Esquema: IUploadingReturn[]

filename: string
Nombre del archivo con la ruta relativa.
ejemplo: "uploads/file.png"

downloadLink: string
Enlace para descargar el archivo.
ejemplo: "https://example.com/uploads/file.png"

size: number
Tamaño del archivo en bytes.
ejemplo: 1024

---