TESSA Web API
    Preparing search index...

    Class CardService

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

    Implements

    Index

    Constructors

    constructor

    Methods

    copy create createFromTemplate delete export get getAndSaveFileContent getAndSaveFileTemplate getFileContent getFileTemplate getFileVersions repair request store

    Constructors

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

      Parameters

      • _component: ICardServiceComponent

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

      • _cardMetadata: ICardMetadata

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

      • _session: ISession

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

      • _fileContentSaver: IFileContentSaver

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

      • _extensionContainer: null | IExtensionContainer

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

      Returns CardService

    Methods

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

      Parameters

      • request: CardCopyRequest

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

      Returns Promise<CardCopyResponse>

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

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

      Parameters

      • request: CardNewRequest

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

      Returns Promise<CardNewResponse>

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

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

      Parameters

      Returns Promise<CardCreateFromTemplateResponse>

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

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

      Parameters

      • request: CardDeleteRequest

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

      Returns Promise<CardDeleteResponse>

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

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

      Parameters

      • request: CardGetRequest

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

      Returns Promise<CardGetResponse>

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

    • Сохраняет контент файла по шаблону.

      Parameters

      • request: CardGetFileTemplateRequest

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

      Returns Promise<ValidationResult>

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

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

      Parameters

      • request: CardGetFileVersionsRequest

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

      Returns Promise<CardGetFileVersionsResponse>

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

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

      Parameters

      • request: CardRepairRequest

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

      Returns Promise<CardRepairResponse>

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

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

      Parameters

      • request: CardRequest

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

      Returns Promise<CardResponse>

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

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

      Parameters

      • request: CardStoreRequest

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

      • OptionalfileContentResolver: null | FileContentResolver

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

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

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

      Returns Promise<CardStoreResponse>

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods