Class OperationService

Сервис, управляющий операциями.

Implements

IOperationService

Index

Constructors

Methods

complete create delete getState getStateAndProgress getStateAndStatus isAlive reportProgress start startFirst tryGet updateStatus

Constructors

constructor

new OperationService(_apiClient: IApiClient): OperationService
Parameters
- _apiClient: IApiClient
Returns OperationService
- Defined in @tessa/platform/src/operations/operationService.ts:18

Methods

complete

complete(id: string, response?: null | OperationResponse): Promise<void>
Завершает операцию заданного типа, т.е. переводит её в состояние OperationState.Completed.
Parameters
- id: string
  Идентификатор операции.
- Optionalresponse: null | OperationResponse
  Результат выполнения операции или null, если для операции недоступна информация о результате.
Returns Promise<void>
Implementation of IOperationService.complete
- Defined in @tessa/platform/src/operations/operationService.ts:144

create

create(args: OperationCreateParams): Promise<string>
Создаёт операцию с заданными параметрами.
Parameters
- args: OperationCreateParams
Returns Promise<string>
Идентификатор созданной операции.
Implementation of IOperationService.create
- Defined in @tessa/platform/src/operations/operationService.ts:24

delete

delete(id: string): Promise<void>
Удаляет операцию с заданным идентификатором. Если операция не существовала, то не выдаётся сообщений об ошибках.
Parameters
- id: string
  Идентификатор операции.
Returns Promise<void>
Implementation of IOperationService.delete
- Defined in @tessa/platform/src/operations/operationService.ts:155

getState

getState(id: string): Promise<null | OperationState>
Возвращает состояние операции с заданным идентификатором или null, если операция не существует.
Parameters
- id: string
  Идентификатор операции.
Returns Promise<null | OperationState>
Состояние операции с заданным идентификатором или null, если операция не существует.
Implementation of IOperationService.getState
- Defined in @tessa/platform/src/operations/operationService.ts:97

getStateAndProgress

getStateAndProgress(id: string): Promise<null | OperationStateAndProgress>
Возвращает состояние и прогресс операции в процентах или null, если операция не найдена.
Parameters
- id: string
  Идентификатор операции.
Returns Promise<null | OperationStateAndProgress>
Состояние операции с заданным идентификатором или null, если операция не существует.
Implementation of IOperationService.getStateAndProgress
- Defined in @tessa/platform/src/operations/operationService.ts:101

getStateAndStatus

getStateAndStatus(id: string): Promise<null | OperationStateAndStatus>
Возвращает состояние и статус операции или null, если операция не найдена.
Parameters
- id: string
  Идентификатор операции.
Returns Promise<null | OperationStateAndStatus>
Состояние и статус операции с заданным идентификатором или null, если операция не существует.
Implementation of IOperationService.getStateAndStatus
- Defined in @tessa/platform/src/operations/operationService.ts:117

isAlive

isAlive(id: string): Promise<boolean>
Возвращает признак того, что операция с заданным идентификатором существует.
Parameters
- id: string
  Идентификатор операции.
Returns Promise<boolean>
true, если операция с заданным идентификатором существует; false в противном случае.
Implementation of IOperationService.isAlive
- Defined in @tessa/platform/src/operations/operationService.ts:91

reportProgress

reportProgress(id: string, progress: number): Promise<boolean>
Сообщает о проценте готовности заданной операции, если операция находится в состоянии OperationState.InProgress и возвращает признак того, что изменение процента готовности удалось.
Parameters
- id: string
  Идентификатор операции.
- progress: number
  Процент готовности операции, выраженный числом от 0 до 100.
Returns Promise<boolean>
true, если операция с заданным идентификатором существует и удалось изменить её процент готовности; false в противном случае.
Implementation of IOperationService.reportProgress
- Defined in @tessa/platform/src/operations/operationService.ts:70

start

start(id: string): Promise<boolean>
Запускает операцию с заданным идентификатором. Операция должна быть создана и находиться в состоянии OperationState.Created.
Parameters
- id: string
  Идентификатор операции, которую следует запустить.
Returns Promise<boolean>
true, если операция с заданным идентификатором существует и успешно запущена; false в противном случае.
Implementation of IOperationService.start
- Defined in @tessa/platform/src/operations/operationService.ts:58

startFirst

startFirst(typeId: string): Promise<null | string>
Запускает из созданных операций заданного типа и возвращает идентификатор запущенной операции или null, если подходящая операция отсутствует.
Parameters
- typeId: string
  Идентификатор типа операции.
Returns Promise<null | string>
Идентификатор запущенной операции или null, если подходящая операция отсутствует.
Implementation of IOperationService.startFirst
- Defined in @tessa/platform/src/operations/operationService.ts:62

tryGet

tryGet(id: string, loadEverything?: boolean): Promise<null | IOperation>
Возвращает информацию по операции с заданным идентификатором или null, если операция отсутствует.
Parameters
- id: string
  Идентификатор операции.
- loadEverything: boolean = true
  Признак того, что должна быть загружена вся информация по операции, включая свойства Operation.request
Returns Promise<null | IOperation>
Информация по операции с заданным идентификатором или null, если операция отсутствует.
Implementation of IOperationService.tryGet
- Defined in @tessa/platform/src/operations/operationService.ts:132

updateStatus

updateStatus(id: string, jsonStatus: null | string): Promise<boolean>
Обновляет статус операции.
Parameters
- id: string
  Идентификатор операции.
- jsonStatus: null | string
  Статус операции.
Returns Promise<boolean>
true, если операция с заданным идентификатором существует и удалось изменить её статус; false в противном случае.
Implementation of IOperationService.updateStatus
- Defined in @tessa/platform/src/operations/operationService.ts:80

Class OperationService

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OperationService

Methods

complete

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<string>

delete

Parameters

Returns Promise<void>

getState

Parameters

Returns Promise<null | OperationState>

getStateAndProgress

Parameters

Returns Promise<null | OperationStateAndProgress>

getStateAndStatus

Parameters

Returns Promise<null | OperationStateAndStatus>

isAlive

Parameters

Returns Promise<boolean>

reportProgress

Parameters

Returns Promise<boolean>

start

Parameters

Returns Promise<boolean>

startFirst

Parameters

Returns Promise<null | string>

tryGet

Parameters

Returns Promise<null | IOperation>

updateStatus

Parameters

Returns Promise<boolean>

Settings

On This Page