Class CardService

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

Hierarchy

  • CardService

Implements

Constructors

constructor

Methods

copy create createFromTemplate delete get getFileContent getFileTemplate getFileVersions repair request store

Constructors

constructor

  • Создаёт экземпляр сервиса карточек с указанием метаинформации по типам карточек, объекта сессии текущего пользователя и используемых компонентов.

    Parameters

    • _component: ICardServiceComponent

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

    • _cardMetadata: ICardMetadata

      Метаинформация по типам карточек.

    • _session: ISession

      Сессия, в рамках которой выполняются операции.

    • _extensionContainer: null | IExtensionContainer

      Контейнер расширений.

    Returns CardService

Methods

copy

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

    Returns

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

    Parameters

    • request: CardCopyRequest

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

    Returns Promise<CardCopyResponse>

create

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

    Returns

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

    Parameters

    • request: CardNewRequest

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

    Returns Promise<CardNewResponse>

createFromTemplate

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

    Returns

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

    Parameters

    Returns Promise<CardCreateFromTemplateResponse>

delete

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

    Returns

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

    Parameters

    • request: CardDeleteRequest

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

    Returns Promise<CardDeleteResponse>

get

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

    Returns

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

    Parameters

    • request: CardGetRequest

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

    Returns Promise<CardGetResponse>

getFileContent

getFileTemplate

getFileVersions

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

    Returns

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

    Parameters

    • request: CardGetFileVersionsRequest

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

    Returns Promise<CardGetFileVersionsResponse>

repair

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

    Returns

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

    Parameters

    • request: CardRepairRequest

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

    Returns Promise<CardRepairResponse>

request

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

    Returns

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

    Parameters

    • request: CardRequest

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

    Returns Promise<CardResponse>

store

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

    Returns

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

    Parameters

    • request: CardStoreRequest

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

    • Optional fileContentResolver: null | FileContentResolver

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

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

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

    Returns Promise<CardStoreResponse>

Generated using TypeDoc