Class CardServiceComponent

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

Hierarchy

CardServiceComponent

Implements

ICardServiceComponent

Index

Constructors

constructor

Methods

copy create createFromTemplate delete get getFileContent getFileTemplate getFileVersions repair request store

Constructors

constructor

new CardServiceComponent(_apiClient: IApiClient, _operationService: IOperationService): CardServiceComponent
Parameters
- _apiClient: IApiClient
- _operationService: IOperationService
Returns CardServiceComponent
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:37

Methods

copy

copy(request: CardCopyRequest): Promise<CardCopyResponse>
Создает копию карточки, переданной в запросе.

Returns
Ответ на запрос, содержащий данные скопированной карточки.
Parameters
- request: CardCopyRequest
  
  Запрос, содержащий информацию по карточке, которая должна быть скопирована.
Returns Promise<CardCopyResponse>
Implementation of ICardServiceComponent.copy
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:167

create

create(request: CardNewRequest): Promise<CardNewResponse>
Возвращает заполненную структуру карточки по заданному запросу. Физически карточка не создаётся.

Returns
Ответ на запрос, содержащий заполненную структуру карточки.
Parameters
- request: CardNewRequest
  
  Запрос, содержащий информацию по карточке, структуру которой необходимо заполнить.
Returns Promise<CardNewResponse>
Implementation of ICardServiceComponent.create
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:53

createFromTemplate

createFromTemplate(request: CardCreateFromTemplateRequest): Promise<CardCreateFromTemplateResponse>
Создает карточку по шаблону, по информации переданной в запросе.

Returns
Результат операции, т.е. внутренний запрос на создание карточки по шаблону и ответ на него. Внутренний запрос может иметь значение null, если его не удалось создать.
Parameters
- request: CardCreateFromTemplateRequest
  
  Запрос на создание карточки по шаблону.
Returns Promise<CardCreateFromTemplateResponse>
Implementation of ICardServiceComponent.createFromTemplate
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:174

delete

delete(request: CardDeleteRequest): Promise<CardDeleteResponse>
Удаляет карточку по информации, переданной в запросе.

Returns
Ответ на запрос, содержащий информацию о валидации процесса удаления карточки, включая сообщения об ошибках.
Parameters
- request: CardDeleteRequest
  
  Запрос, содержащий информацию по карточке, которая должна быть удалена.
Returns Promise<CardDeleteResponse>
Implementation of ICardServiceComponent.delete
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:160

get

get(request: CardGetRequest): Promise<CardGetResponse>
Возвращает данные карточки по заданному запросу.

Returns
Ответ на запрос, содержащий данные запрашиваемой карточки.
Parameters
- request: CardGetRequest
  
  Запрос, содержащий информацию по карточке, которая должна быть возвращена.
Returns Promise<CardGetResponse>
Implementation of ICardServiceComponent.get
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:60

getFileContent

getFileContent(request: CardGetFileContentRequest): Promise<CardGetFileContentResponse>
Получает контент версии файла.

Returns
Ответ на запрос по получению контента версии файла и контент файла.
Parameters
- request: CardGetFileContentRequest
  
  Запрос на получение контента версии файла.
Returns Promise<CardGetFileContentResponse>
Implementation of ICardServiceComponent.getFileContent
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:190

getFileTemplate

getFileTemplate(request: CardGetFileTemplateRequest): Promise<CardGetFileContentResponse>
Получает контент файла по шаблону.

Returns
Ответ на запрос по получению контента файла по шаблону и контент файла.
Parameters
- request: CardGetFileTemplateRequest
  
  Запрос, содержащий информацию, необходимую для создания файла по шаблону.
Returns Promise<CardGetFileContentResponse>
Implementation of ICardServiceComponent.getFileTemplate
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:215

getFileVersions

getFileVersions(request: CardGetFileVersionsRequest): Promise<CardGetFileVersionsResponse>
Возвращает информацию о версиях файла по заданному запросу.

Returns
Ответ на запрос, содержащий данные запрашиваемых версий файла.
Parameters
- request: CardGetFileVersionsRequest
  
  Запрос, содержащий информацию о версиях файла, которые должны быть возвращены.
Returns Promise<CardGetFileVersionsResponse>
Implementation of ICardServiceComponent.getFileVersions
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:240

repair

repair(request: CardRepairRequest): Promise<CardRepairResponse>
Восстанавливает структуру карточки.

Returns
Ответ на запрос, содержащий данные восстановленной карточки.
Parameters
- request: CardRepairRequest
  
  Запрос, содержащий информацию по карточке, которая должна быть восстановлена.
Returns Promise<CardRepairResponse>
Implementation of ICardServiceComponent.repair
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:183

request

request(request: CardRequest): Promise<CardResponse>
Выполняет универсальный запрос к сервису карточек.

Returns
Ответ на универсальный запрос к сервису карточек.
Parameters
- request: CardRequest
  
  Универсальный запрос к сервису карточек.
Returns Promise<CardResponse>
Implementation of ICardServiceComponent.request
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:46

store

store(request: CardStoreRequest, fileContentResolver?: null | FileContentResolver, onProgress?: null | ((val: number) => Promise<void>)): Promise<CardStoreResponse>
Сохраняет карточку, переданную в запросе.

Returns
Ответ на запрос, содержащий информацию о валидации процесса сохранения карточки, включая сообщения об ошибках.
Parameters
- request: CardStoreRequest
  
  Запрос на сохранение карточки, содержащий изменённую информацию о карточке.
- Optional fileContentResolver: null | FileContentResolver
  
  Функция для получения информации по контенту файлов, сохраняемых в карточке.
- Optional onProgress: null | ((val: number) => Promise<void>)
  
  Колбек вызываемый для отслеживания прогресса сохранения карточки.
Returns Promise<CardStoreResponse>
Implementation of ICardServiceComponent.store
- Defined in @tessa/platform/src/cards/service/cardServiceComponent.ts:67

Class CardServiceComponent

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

_apiClient: IApiClient

_operationService: IOperationService

Returns CardServiceComponent

Methods

copy

Returns

Parameters

request: CardCopyRequest

Returns Promise<CardCopyResponse>

create

Returns

Parameters

request: CardNewRequest

Returns Promise<CardNewResponse>

createFromTemplate

Returns

Parameters

request: CardCreateFromTemplateRequest

Returns Promise<CardCreateFromTemplateResponse>

delete

Returns

Parameters

request: CardDeleteRequest

Returns Promise<CardDeleteResponse>

get

Returns

Parameters

request: CardGetRequest

Returns Promise<CardGetResponse>

getFileContent

Returns

Parameters

request: CardGetFileContentRequest

Returns Promise<CardGetFileContentResponse>

getFileTemplate

Returns

Parameters

request: CardGetFileTemplateRequest

Returns Promise<CardGetFileContentResponse>

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>

`Optional` fileContentResolver: null | FileContentResolver

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