Структура данных, предоставляющая информацию об индикаторе выполнения.
cancellable |
Возвращает значение true, если событие, связанное с индикатором выполнения, можно отменить. |
currentStep |
Возвращает текущий шаг для этого индикатора выполнения. |
description |
Возвращает описание индикатора выполнения. |
elapsedTime |
Возвращает количество секунд, в течение которых работал индикатор выполнения. |
exists |
Проверяет наличие индикатора выполнения. |
finished |
Возвращает значение true, если индикатор выполнения завершен, но не удален. |
id |
Возвращает уникальный идентификатор индикатора выполнения. |
indefinite |
Возвращает значение true, если индикатор выполнения не определен. |
name |
Возвращает имя индикатора выполнения. |
options |
Возвращает флаги параметров, используемые для запуска индикатора выполнения. |
parentId |
Возвращает уникальный идентификатор родителя индикатора выполнения или -1, если индикатор выполнения не является дочерним элементом другого индикатора выполнения. |
pausable |
Возвращает значение true, если задачу индикатора выполнения можно приостановить. |
paused |
Возвращает значение true, если индикатор выполнения приостановлен. |
priority |
Возвращает приоритет индикатора выполнения. |
progress |
Возвращает значение хода выполнения задачи, связанной с индикатором выполнения. |
remainingTime |
Возвращает оставшееся время индикатора выполнения до завершения. |
responding |
Возвращает значение true, если прогресс продолжается, и false, если индикатор выполнения не получает никаких отчетов о ходе выполнения в течение более 5 секунд. |
running |
Возвращает значение true, если индикатор выполнения запущен и активен. |
startTime |
Возвращает время запуска индикатора выполнения. |
status |
Возвращает состояние индикатора выполнения. |
stepLabel |
Возвращает метку, отображающую шаги индикатора выполнения. |
timeDisplayMode |
Возвращает режим отображения времени индикатора прогресса. |
totalSteps |
Возвращает общее количество шагов от начала до конца для этого индикатора выполнения. |
updateTime |
Возвращает время последнего обновления индикатора хода выполнения. |
Cancel |
Отменяет работающий индикатор выполнения. |
ClearRemainingTime |
Сбрасывает расчет оставшегося времени индикатора выполнения. |
Finish |
Отмечает индикатор выполнения как завершенный. |
Pause |
Приостанавливает работающий индикатор выполнения. |
RegisterCancelCallback |
Регистрирует обратный вызов, который вызывается, когда пользователь отменяет задачу, связанную с запущенным индикатором выполнения. |
RegisterPauseCallback |
Регистрирует обратный вызов, который вызывается, когда пользователь приостанавливает выполнение задачи индикатора выполнения. |
Remove |
Завершает и удаляет активный индикатор выполнения. |
Report |
Сообщает о текущем состоянии индикатора выполнения. |
Resume |
Восстанавливает приостановленный индикатор выполнения. |
SetDescription |
Задает описание индикатора выполнения. Чтобы очистить описание, передайте null. |
SetPriority |
Устанавливает приоритет индикатора выполнения. |
SetRemainingTime |
Устанавливает оставшееся время индикатора выполнения в секундах. |
SetStepLabel |
Задает метку, отображающую шаги индикатора выполнения. |
SetTimeDisplayMode |
Установите режим отображения времени индикатора прогресса. |
UnregisterCancelCallback |
Отменяет регистрацию ранее зарегистрированного обратного вызова отмены выполнения. |
UnregisterPauseCallback |
Отменяет регистрацию ранее зарегистрированного обратного вызова приостановки выполнения. |