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

Интерфейс DownloadFileServiceType

Интерфейс сервиса для скачивания файлов

interface DownloadFileServiceType {
    buildLobFilePath: (fileType: "blob" | "clob", fileId: string) => string;
    byFile: (file: Blob, name: string) => void;
    byJSONData: (data: string, name: string) => void;
    byUrl: (url: string, apiVersion?: string) => void;
    byXMLData: (data: string, name: string) => void;
    readLobFile: (fileType: "blob" | "clob", fileId: string) => Promise<Blob>;
}
Индекс

Свойства

buildLobFilePath: (fileType: "blob" | "clob", fileId: string) => string

Метод для формирования пути к файлу LOB (Large Object) в структуре хранилища.

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

    • (fileType: "blob" | "clob", fileId: string): string
    • Параметры

      • fileType: "blob" | "clob"

        тип объекта: 'blob' или 'clob'.

      • fileId: string

        уникальный идентификатор файла.

      Возвращает string

byFile: (file: Blob, name: string) => void

Метод скачивания файла.

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

    • (file: Blob, name: string): void
    • Параметры

      • file: Blob

        Файл.

      • name: string

        Имя файла.

      Возвращает void

byJSONData: (data: string, name: string) => void

Метод скачивания файла из данных JSON.

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

    • (data: string, name: string): void
    • Параметры

      • data: string

        Данные JSON.

      • name: string

        Имя файла.

      Возвращает void

byUrl: (url: string, apiVersion?: string) => void

Метод скачивания по ссылке.

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

    • (url: string, apiVersion?: string): void
    • Параметры

      • url: string

        URL-адрес.

      • OptionalapiVersion: string

        Версия API.

      Возвращает void

byXMLData: (data: string, name: string) => void

Метод скачивания файла из данных XML.

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

    • (data: string, name: string): void
    • Параметры

      • data: string

        Данные XML.

      • name: string

        Имя файла.

      Возвращает void

readLobFile: (fileType: "blob" | "clob", fileId: string) => Promise<Blob>

Метод для чтения файла LOB (Large Object) из хранилища.

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

    • (fileType: "blob" | "clob", fileId: string): Promise<Blob>
    • Параметры

      • fileType: "blob" | "clob"

        тип объекта: 'blob' или 'clob'.

      • fileId: string

        уникальный идентификатор файла.

      Возвращает Promise<Blob>