Class CardImportService

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

Implements

ICardImportService

Index

Constructors

constructor

Methods

cancel create delete import

Constructors

constructor

new CardImportService(_apiClient: IApiClient): CardImportService
Parameters
- _apiClient: IApiClient
Returns CardImportService
- Defined in @tessa/platform/src/cards/service/cardImportService.ts:18

Methods

cancel

cancel(id: string): Promise<ValidationResult>
Прерывает импорт карточек.
Parameters
- id: string
  Идентификатор карточки "Импорт карточек".
Returns Promise<ValidationResult>
Результат выполнения запроса.
Implementation of ICardImportService.cancel
- Defined in @tessa/platform/src/cards/service/cardImportService.ts:58

create

create(
request: CreateCardImportRequest,
contents: File[],
): Promise<CreateCardImportResponse>
Создает карточку "Импорт карточек".
Parameters
- request: CreateCardImportRequest
  Запрос на создание карточки.
- contents: File[]
  Импортируемые файлы:
  
  либо список файлов формата .jcard (т.е. карточки без вложенных в них файлов),
  
  либо один zip-архив, в котором в корне содержатся карточки, а соответствующих папках - вложенные файлы (если они есть),
  
  либо zip-архив и файл библиотеки карточек .jcardlib.
Returns Promise<CreateCardImportResponse>
Результат запроса на создание. В нем содержится результат валидации, идентификатор созданной карточки "Импорт карточек", а также все найденные карточки. При этом:
- если были приложены простые карточки .jcard, то будут перечислены именно они,
- если был приложен только zip-архив, то будут перечислены карточки из корня архива,
- если был приложен zip-архив и файл библиотеки .jcardlib, то карточки будут взяты из файла библиотеки.
Implementation of ICardImportService.create
- Defined in @tessa/platform/src/cards/service/cardImportService.ts:24

delete

delete(id: string): Promise<ValidationResult>
Удаляет карточку "Импорт карточек".
Parameters
- id: string
  Идентификатор карточки "Импорт карточек".
Returns Promise<ValidationResult>
Результат выполнения запроса.
Implementation of ICardImportService.delete
- Defined in @tessa/platform/src/cards/service/cardImportService.ts:71

import

import(request: StartCardImportRequest): Promise<ValidationResult>
Ставит карточку "Импорт карточек" в очередь на обработку.
Parameters
- request: StartCardImportRequest
  Запрос на постановку карточки в очередь на импорт. В запросе указываются выбранные для импорта карточки.
Returns Promise<ValidationResult>
Результат выполнения запроса.
Implementation of ICardImportService.import
- Defined in @tessa/platform/src/cards/service/cardImportService.ts:45

Class CardImportService

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CardImportService

Methods

cancel

Parameters

Returns Promise<ValidationResult>

create

Parameters

Returns Promise<CreateCardImportResponse>

delete

Parameters

Returns Promise<ValidationResult>

import

Parameters

Returns Promise<ValidationResult>

Settings

On This Page