Перейти к основному контенту

загрузка

Загрузите файл в облачное хранилище oneentry.

Описание

Этот метод загружает файл в облачное файловое хранилище. Передайте в качестве даты значение, полученное из поля ввода типа "file". Он возвращает Promise, который разрешается в объект IUploadingReturn[].

Данные — это объект файла (или массив), подробнее - Объект File

FileUploading.upload(

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

);

Схема параметров

Схема

file(обязательный): File | Blob
Файл для загрузки
пример: new File(["content"], "file.png", {"type": "image/png"})

fileQuery: IUploadingQuery
Необязательные параметры запроса
пример:

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

fileQuery.type(обязательный): string
Тип, определяет имя папки в хранилище.
пример: "page"

fileQuery.entity(обязательный): string
Имя сущности, из которой загружается файл, определяет имя папки в хранилище.
пример: "editor"

fileQuery.id(обязательный): number
Идентификатор объекта, из которого загружается файл, определяет имя папки в хранилище.
пример: 3787

fileQuery.width: number
Параметр ширины.
пример: 0

fileQuery.height: number
Параметр высоты.
пример: 0

fileQuery.compress: boolean
Флаг оптимизации (сжатия) для изображений.
пример: true

Примеры

Минимальный пример

const fileQuery = {
"type": "page",
"entity": "editor",
"id": 3787,
"width": 0,
"height": 0,
"compress": true
}

const response = await FileUploading.upload(file, fileQuery);

Пример ответа

[
{
"filename": "files/project/page/3492/editor/errors-1751677276135-1753090805481.md",
"downloadLink": "https://stage.oneentry.ru/cloud-static/files/project/page/3492/editor/errors-1751677276135-1753090805481.md",
"size": 4463
}
]

Схема ответа

Схема: IUploadingReturn[]

filename: string
Имя файла с относительным путем.
пример: "uploads/file.png"

downloadLink: string
Ссылка для скачивания файла.
пример: "https://example.com/uploads/file.png"

size: number
Размер файла в байтах.
пример: 1024