Class OperationService

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

Hierarchy

  • OperationService

Implements

Constructors

constructor

Methods

complete create delete deleteOlderThan getAll getState getStateAndProgress isAlive reportProgress start startFirst tryGet

Constructors

constructor

Methods

complete

  • Завершает операцию заданного типа, т.е. переводит её в состояние Completed.

    Parameters

    • id: string

      Идентификатор операции.

    • Optional response: null | OperationResponse

      Результат выполнения операции или null, если для операции недоступна информация о результате.

    Returns Promise<void>

create

  • Создаёт операцию с заданными параметрами.

    Returns

    Идентификатор созданной операции.

    Parameters

    Returns Promise<string>

delete

  • Удаляет операцию с заданным идентификатором. Если операция не существовала, то не выдаётся сообщений об ошибках.

    Parameters

    • id: string

      Идентификатор операции.

    Returns Promise<void>

deleteOlderThan

  • Выполняет удаление записей, которые были созданы раньше заданных даты и времени.

    Returns

    Число удалённых записей.

    Parameters

    • dateTime: string

      Дата и время, раньше которых удаляются записи.

    Returns Promise<number>

getAll

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

    Returns

    Список всех операций.

    Parameters

    • typeId: string

      Идентификатор типа возвращаемых операций.

    • loadEverything: boolean = true

      Признак того, что должна быть загружена вся информация по операции, включая свойства request

    Returns Promise<readonly IOperation[]>

getState

  • Возвращает состояние операции с заданным идентификатором или null, если операция не существует.

    Returns

    Состояние операции с заданным идентификатором или null, если операция не существует.

    Parameters

    • id: string

      Идентификатор операции.

    Returns Promise<null | OperationState>

getStateAndProgress

  • Возвращает состояние и прогресс операции в процентах или null, если операция не найдена.

    Returns

    Состояние операции с заданным идентификатором или null, если операция не существует.

    Parameters

    • id: string

      Идентификатор операции.

    Returns Promise<null | OperationStateAndProgress>

isAlive

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

    Returns

    true, если операция с заданным идентификатором существует; false в противном случае.

    Parameters

    • id: string

      Идентификатор операции.

    Returns Promise<boolean>

reportProgress

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

    Returns

    true, если операция с заданным идентификатором существует и удалось изменить её процент готовности; false в противном случае.

    Parameters

    • id: string

      Идентификатор операции.

    • progress: number

      Процент готовности операции, выраженный числом от 0 до 100.

    Returns Promise<boolean>

start

  • Запускает операцию с заданным идентификатором. Операция должна быть создана и находиться в состоянии Created.

    Parameters

    • id: string

      Идентификатор операции, которую следует запустить.

    Returns Promise<void>

startFirst

  • Запускает из созданных операций заданного типа и возвращает идентификатор запущенной операции или null, если подходящая операция отсутствует.

    Returns

    Идентификатор запущенной операции или null, если подходящая операция отсутствует.

    Parameters

    • typeId: string

      Идентификатор типа операции.

    Returns Promise<null | string>

tryGet

  • Возвращает информацию по операции с заданным идентификатором или null, если операция отсутствует.

    Returns

    Информация по операции с заданным идентификатором или null, если операция отсутствует.

    Parameters

    • id: string

      Идентификатор операции.

    • loadEverything: boolean = true

      Признак того, что должна быть загружена вся информация по операции, включая свойства request

    Returns Promise<null | IOperation>

Generated using TypeDoc