Class Operation

Операция.

Hierarchy

Implements

Constructors

constructor

Accessors

completed created createdById createdByName creationFlags digest id inProgress postponed progress reportsProgress request requestHash response sessionId state typeId

Methods

clean ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated validate

Constructors

constructor

  • Создает операцию с параметрами по умолчанию.

    Returns Operation

  • Создаёт экземпляр класса с указанием операции, свойства которой используются для инициализации создаваемого объекта.

    Parameters

    • operation: IOperation

      Операция, свойства которой используются для инициализации создаваемого объекта.

    Returns Operation

  • Создаёт экземпляр класса с указанием хранилища (или пустое хранилище по умолчанию), декоратором для которого является создаваемый объект.

    Parameters

    • storage: IStorage<unknown>

      Хранилище, декоратором для которого является создаваемый объект.

    Returns Operation

Accessors

completed

  • get completed(): null | string

  • Дата и время окончания операции в UTC или null, если операция ещё не завершена.

    Returns null | string

  • set completed(value: null | string): void

  • Дата и время окончания операции в UTC или null, если операция ещё не завершена.

    Parameters

    • value: null | string

    Returns void

created

  • get created(): string

  • Дата и время создания операции в UTC.

    Returns string

  • set created(value: string): void

  • Дата и время создания операции в UTC.

    Parameters

    • value: string

    Returns void

createdById

  • get createdById(): string

  • Идентификатор пользователя, создавшего запрос на операцию.

    Returns string

  • set createdById(value: string): void

  • Идентификатор пользователя, создавшего запрос на операцию.

    Parameters

    • value: string

    Returns void

createdByName

  • get createdByName(): string

  • Имя пользователя, создавшего запрос на операцию.

    Returns string

  • set createdByName(value: string): void

  • Имя пользователя, создавшего запрос на операцию.

    Parameters

    • value: string

    Returns void

creationFlags

digest

  • get digest(): null | string

  • Краткое описание операции.

    Returns null | string

  • set digest(value: null | string): void

  • Краткое описание операции.

    Parameters

    • value: null | string

    Returns void

id

  • get id(): string

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

    Returns string

  • set id(value: string): void

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

    Parameters

    • value: string

    Returns void

inProgress

  • get inProgress(): null | string

  • Дата и время начала выполнения операции в UTC или null, если выполнение операции ещё не начато.

    Returns null | string

  • set inProgress(value: null | string): void

  • Дата и время начала выполнения операции в UTC или null, если выполнение операции ещё не начато.

    Parameters

    • value: null | string

    Returns void

postponed

  • get postponed(): null | string

  • Дата и время, до наступления которого операция отложена, или null, если операция не отложена.

    Returns null | string

  • set postponed(value: null | string): void

  • Дата и время, до наступления которого операция отложена, или null, если операция не отложена.

    Parameters

    • value: null | string

    Returns void

progress

  • get progress(): null | number

  • Процент выполнения операции от 0 до 100 или null, если операция не сообщает процент своей готовности.

    Returns null | number

  • set progress(value: null | number): void

  • Процент выполнения операции от 0 до 100 или null, если операция не сообщает процент своей готовности.

    Parameters

    • value: null | number

    Returns void

reportsProgress

  • get reportsProgress(): boolean

  • Признак того, что операция сообщает о проценте своей готовности.

    Returns boolean

request

  • get request(): null | OperationRequest

  • Запрос на выполнение операции или null, если для выполнения операции не требуется запрос.

    Returns null | OperationRequest

  • set request(value: null | OperationRequest): void

  • Запрос на выполнение операции или null, если для выполнения операции не требуется запрос.

    Parameters

    Returns void

requestHash

  • get requestHash(): null | string

  • Хеш, посчитанный для данных в запросе Request, или null, если для выполнения операции не требуется запрос.

    Для расчёта обычно используется функция хеширования HMAC-SHA256, размер хеша в которой 256 бит или 32 байта.

    Расчёт выполняется автоматически в момент создания операции. Заполнять поле вручную не рекомендуется.

    Returns null | string

  • set requestHash(value: null | string): void

  • Хеш, посчитанный для данных в запросе Request, или null, если для выполнения операции не требуется запрос.

    Для расчёта обычно используется функция хеширования HMAC-SHA256, размер хеша в которой 256 бит или 32 байта.

    Расчёт выполняется автоматически в момент создания операции. Заполнять поле вручную не рекомендуется.

    Parameters

    • value: null | string

    Returns void

response

  • get response(): null | OperationResponse

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

    Returns null | OperationResponse

  • set response(value: null | OperationResponse): void

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

    Parameters

    Returns void

sessionId

  • get sessionId(): string

  • Идентификатор сессии, в рамках которой была создана операция.

    Returns string

  • set sessionId(value: string): void

  • Идентификатор сессии, в рамках которой была создана операция.

    Parameters

    • value: string

    Returns void

state

typeId

  • get typeId(): string

  • Идентификатор типа операции. Должен быть добавлен в перечисление OperationTypes.

    Returns string

  • set typeId(value: string): void

  • Идентификатор типа операции. Должен быть добавлен в перечисление OperationTypes.

    Parameters

    • value: string

    Returns void

Methods

clean

  • Выполняет очистку хранилища от избыточных данных.

    Returns void

ensureCacheResolved

  • Выполняет резолв кеша декораторов для данных объекта-хранилища.

    Returns void

getStorage

  • Возвращает хранилище IStorage, декоратором для которого является текущий объект.

    Returns

    Хранилище IStorage, декоратором для которого является текущий объект.

    Returns IStorage<unknown>

getStorageSettings

isValid

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

    Returns

    true, если объект прошёл проверку на валидность; false в противном случае.

    Returns boolean

notifyStorageUpdated

  • Метод, уведомляющий объект о наличии изменений в его хранилище.

    Returns void

validate

  • Выполняет валидацию текущего объекта и всех его дочерних объектов.

    Returns

    Объект, выполняющий построение результата валидации.

    Returns ValidationResult

Generated using TypeDoc