Interface ICardService

Сервис для управления карточками.

interface ICardService {
    copy(request: CardCopyRequest): Promise<CardCopyResponse>;
    create(request: CardNewRequest): Promise<CardNewResponse>;
    createFromTemplate(
        request: CardCreateFromTemplateRequest,
    ): Promise<CardCreateFromTemplateResponse>;
    delete(request: CardDeleteRequest): Promise<CardDeleteResponse>;
    get(request: CardGetRequest): Promise<CardGetResponse>;
    getFileContent(
        request: CardGetFileContentRequest,
    ): Promise<CardGetFileContentResponse>;
    getFileTemplate(
        request: CardGetFileTemplateRequest,
    ): Promise<CardGetFileContentResponse>;
    getFileVersions(
        request: CardGetFileVersionsRequest,
    ): Promise<CardGetFileVersionsResponse>;
    repair(request: CardRepairRequest): Promise<CardRepairResponse>;
    request(request: CardRequest): Promise<CardResponse>;
    store(
        request: CardStoreRequest,
        fileContentResolver?: null | FileContentResolver,
        onProgress?: null | (val: number) => Promise<void>,
    ): Promise<CardStoreResponse>;
}

Hierarchy (View Summary, Expand)

Implemented by

Methods

copy create createFromTemplate delete get getFileContent getFileTemplate getFileVersions repair request store

Methods

copy

  • copy(request: CardCopyRequest): Promise<CardCopyResponse>

    Создает копию карточки, переданной в запросе.

    Parameters

    • request: CardCopyRequest

      Запрос, содержащий информацию по карточке, которая должна быть скопирована.

    Returns Promise<CardCopyResponse>

    Ответ на запрос, содержащий данные скопированной карточки.

create

  • create(request: CardNewRequest): Promise<CardNewResponse>

    Возвращает заполненную структуру карточки по заданному запросу. Физически карточка не создаётся.

    Parameters

    • request: CardNewRequest

      Запрос, содержащий информацию по карточке, структуру которой необходимо заполнить.

    Returns Promise<CardNewResponse>

    Ответ на запрос, содержащий заполненную структуру карточки.

createFromTemplate

  • createFromTemplate(
        request: CardCreateFromTemplateRequest,
    ): Promise<CardCreateFromTemplateResponse>

    Создает карточку по шаблону, по информации переданной в запросе.

    Parameters

    Returns Promise<CardCreateFromTemplateResponse>

    Результат операции, т.е. внутренний запрос на создание карточки по шаблону и ответ на него. Внутренний запрос может иметь значение null, если его не удалось создать.

delete

  • delete(request: CardDeleteRequest): Promise<CardDeleteResponse>

    Удаляет карточку по информации, переданной в запросе.

    Parameters

    • request: CardDeleteRequest

      Запрос, содержащий информацию по карточке, которая должна быть удалена.

    Returns Promise<CardDeleteResponse>

    Ответ на запрос, содержащий информацию о валидации процесса удаления карточки, включая сообщения об ошибках.

get

  • get(request: CardGetRequest): Promise<CardGetResponse>

    Возвращает данные карточки по заданному запросу.

    Parameters

    • request: CardGetRequest

      Запрос, содержащий информацию по карточке, которая должна быть возвращена.

    Returns Promise<CardGetResponse>

    Ответ на запрос, содержащий данные запрашиваемой карточки.

getFileContent

  • getFileContent(
        request: CardGetFileContentRequest,
    ): Promise<CardGetFileContentResponse>

    Получает контент версии файла.

    Parameters

    Returns Promise<CardGetFileContentResponse>

    Ответ на запрос по получению контента версии файла и контент файла.

getFileTemplate

  • getFileTemplate(
        request: CardGetFileTemplateRequest,
    ): Promise<CardGetFileContentResponse>

    Получает контент файла по шаблону.

    Parameters

    • request: CardGetFileTemplateRequest

      Запрос, содержащий информацию, необходимую для создания файла по шаблону.

    Returns Promise<CardGetFileContentResponse>

    Ответ на запрос по получению контента файла по шаблону и контент файла.

getFileVersions

  • getFileVersions(
        request: CardGetFileVersionsRequest,
    ): Promise<CardGetFileVersionsResponse>

    Возвращает информацию о версиях файла по заданному запросу.

    Parameters

    • request: CardGetFileVersionsRequest

      Запрос, содержащий информацию о версиях файла, которые должны быть возвращены.

    Returns Promise<CardGetFileVersionsResponse>

    Ответ на запрос, содержащий данные запрашиваемых версий файла.

repair

  • repair(request: CardRepairRequest): Promise<CardRepairResponse>

    Восстанавливает структуру карточки.

    Parameters

    • request: CardRepairRequest

      Запрос, содержащий информацию по карточке, которая должна быть восстановлена.

    Returns Promise<CardRepairResponse>

    Ответ на запрос, содержащий данные восстановленной карточки.

request

  • request(request: CardRequest): Promise<CardResponse>

    Выполняет универсальный запрос к сервису карточек.

    Parameters

    • request: CardRequest

      Универсальный запрос к сервису карточек.

    Returns Promise<CardResponse>

    Ответ на универсальный запрос к сервису карточек.

store

  • store(
        request: CardStoreRequest,
        fileContentResolver?: null | FileContentResolver,
        onProgress?: null | (val: number) => Promise<void>,
    ): Promise<CardStoreResponse>

    Сохраняет карточку, переданную в запросе.

    Parameters

    • request: CardStoreRequest

      Запрос на сохранение карточки, содержащий изменённую информацию о карточке.

    • OptionalfileContentResolver: null | FileContentResolver

      Функция для получения информации по контенту файлов, сохраняемых в карточке.

    • OptionalonProgress: null | (val: number) => Promise<void>

      Колбек вызываемый для отслеживания прогресса сохранения карточки.

    Returns Promise<CardStoreResponse>

    Ответ на запрос, содержащий информацию о валидации процесса сохранения карточки, включая сообщения об ошибках.

Settings

Member Visibility

On This Page

Methods
MMNEPVFCICPMFPCPTTAAATR