Юниверс DG SDK UI
v2.15.0

Интерфейс UploadCustomRequestOptions

Пользовательский запрос на загрузку

interface UploadCustomRequestOptions {
    action: string;
    data: object;
    file: RcFile;
    filename: string;
    headers: object;
    onError: (error: Error, response?: any, file?: RcFile) => void;
    onProgress: (event: { percent: number }, file: RcFile) => void;
    onSuccess: (response: object, file: RcFile) => void;
    withCredentials: boolean;
}
Индекс

Свойства

action: string

URL-адрес загрузки или конечная точка.

data: object

Дополнительные данные, отправляемые в запросе.

file: RcFile

Объект файла для загрузки.

filename: string

Имя файла в запросе.

headers: object

Заголовки HTTP-запроса.

onError: (error: Error, response?: any, file?: RcFile) => void

Колбэк, вызываемый при ошибке загрузки.

Объявление типа

    • (error: Error, response?: any, file?: RcFile): void
    • Параметры

      • error: Error

        Объект ошибки.

      • Optionalresponse: any

        Дополнительная информация с сервера.

      • Optionalfile: RcFile

        Загружаемый файл.

      Возвращает void

onProgress: (event: { percent: number }, file: RcFile) => void

Колбэк, вызываемый при обновлении прогресса загрузки.

Объявление типа

    • (event: { percent: number }, file: RcFile): void
    • Параметры

      • event: { percent: number }

        Объект прогресса с текущим процентом.

      • file: RcFile

        Загружаемый файл.

      Возвращает void

onSuccess: (response: object, file: RcFile) => void

Колбэк, вызываемый при успешной загрузке.

Объявление типа

    • (response: object, file: RcFile): void
    • Параметры

      • response: object

        Ответ сервера.

      • file: RcFile

        Загружаемый файл.

      Возвращает void

withCredentials: boolean

Использовать ли учетные данные при запросе.