Interface IOperationService

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

interface IOperationService {
    complete(id: string, response?: null | OperationResponse): Promise<void>;
    create(params: OperationCreateParams): Promise<string>;
    delete(id: string): Promise<void>;
    deleteOlderThan(dateTime: string): Promise<number>;
    getAll(
        typeId: string,
        loadEverything?: boolean,
    ): Promise<readonly IOperation[]>;
    getState(id: string): Promise<null | OperationState>;
    getStateAndProgress(id: string): Promise<null | OperationStateAndProgress>;
    isAlive(id: string): Promise<boolean>;
    reportProgress(id: string, progress: number): Promise<boolean>;
    start(id: string): Promise<void>;
    startFirst(typeId: string): Promise<null | string>;
    tryGet(id: string, loadEverything?: boolean): Promise<null | IOperation>;
}

Implemented by

Methods

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

Methods

complete

  • complete(id: string, response?: null | OperationResponse): Promise<void>

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

    Parameters

    • id: string

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

    • Optionalresponse: null | OperationResponse

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

    Returns Promise<void>

create

  • create(params: OperationCreateParams): Promise<string>

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

    Parameters

    Returns Promise<string>

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

delete

  • delete(id: string): Promise<void>

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

    Parameters

    • id: string

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

    Returns Promise<void>

deleteOlderThan

  • deleteOlderThan(dateTime: string): Promise<number>

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

    Parameters

    • dateTime: string

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

    Returns Promise<number>

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

getAll

  • getAll(typeId: string, loadEverything?: boolean): Promise<readonly IOperation[]>

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

    Parameters

    • typeId: string

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

    • OptionalloadEverything: boolean

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

    Returns Promise<readonly IOperation[]>

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

getState

  • getState(id: string): Promise<null | OperationState>

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

    Parameters

    • id: string

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

    Returns Promise<null | OperationState>

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

getStateAndProgress

  • getStateAndProgress(id: string): Promise<null | OperationStateAndProgress>

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

    Parameters

    • id: string

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

    Returns Promise<null | OperationStateAndProgress>

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

isAlive

  • isAlive(id: string): Promise<boolean>

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

    Parameters

    • id: string

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

    Returns Promise<boolean>

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

reportProgress

  • reportProgress(id: string, progress: number): Promise<boolean>

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

    Parameters

    • id: string

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

    • progress: number

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

    Returns Promise<boolean>

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

start

  • start(id: string): Promise<void>

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

    Parameters

    • id: string

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

    Returns Promise<void>

startFirst

  • startFirst(typeId: string): Promise<null | string>

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

    Parameters

    • typeId: string

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

    Returns Promise<null | string>

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

tryGet

  • tryGet(id: string, loadEverything?: boolean): Promise<null | IOperation>

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

    Parameters

    • id: string

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

    • OptionalloadEverything: boolean

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

    Returns Promise<null | IOperation>

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

Settings

Member Visibility

On This Page

Methods
MMNEPVFCICPMFPCPTTAAATR