...
Фоновая активность (фоновый процесс) — используется для процессов, занимающих продолжительное время. Не мешает продолжать работу и отдает идентификатор активности, по которому можно получать информацию о том что в ней происходит (например, прогресс выполнения в %), прервать её или дать интерактивный ответ на возникший в процессе вопрос к оператору, если он есть.
...
Фоновая активность идентифицируется двумя значениями: тип и идентификатор. Все методы, запускающие фоновые активности (обычно начинающиеся на Run*), возвращают именно эту пару значений — тип и идентификатор. А все методы, работающие с активностями, принимают эти два значения.
Найти фоновые активности
Метод SearchBackgroundActivities — метод для нахождения фоновых активностей. Необходим, чтобы знать, что сейчас происходит в системе.
Принимает:
Аргумент | Тип | Описание |
---|---|---|
instanceKey | String | Ключ экземпляра приложения |
language | String | Язык для запрашиваемых данных |
sessionId | String | Идентификатор сессии |
xmlSearchParameters | String |
Возвращает : BackgroundActivityInfoListAnswer (список краткой информации об активностях)
параметры поиска активностей, которыми можно, например, ограничить определенные типы активностей. В частности, в интерфейсе Автовыкупа незачем показывать активности, не связанные с ним.
Для простого получения всех активностей можно передать
Блок кода | ||
---|---|---|
| ||
<BackgroundActivitySearchParameters></BackgroundActivitySearchParameters> |
Возвращает: список фоновых активностей, с краткой информацией о них. В краткой информации (BackgroundActivityInfoListAnswer) сразу можно узнать всё, кроме списка шагов активности. Подробнее обо всех свойствах активности описано ниже.
Получить информацию
...
о фоновой активности
Метод GetBackgroundActivityInfo — метод для получения фоновой активности. Необходим, чтобы показывать процесс, что происходит в данной активности
Принимает:
Аргумент | Тип | Описание |
---|---|---|
instanceKey | String | Ключ экземпляра приложения |
language | String | Язык для запрашиваемых данных |
sessionId | String | Идентификатор сессии |
activityType | String | Тип фоновой активности |
activityId | String | Идентификатор фоновой активности |
Возвращает : BackgroundActivityFullInfoAnswer : описание активности, признак завершения, % прогресса, признак требования действия оператора (и если он есть, то описание и список вариантов действий), список шагов в работе активности. Про каждый шаг: тип (инфо, успех, ошибка, предупреждение) и текст.
Выполнить действие шага для фоновой активности
Метод DoStepActionForBackgroundActivity
Принимает:
Аргумент | Тип | Описание |
---|---|---|
instanceKey | String | Ключ экземпляра приложения |
language | String | Язык для запрашиваемых данных |
sessionId | String | Идентификатор сессии |
activityType | String | Тип фоновой активности |
activityId | String | Идентификатор фоновой активности |
xmlParameters | String |
тип и идентификатор фоновой активности
Возвращает: полную информацию о фоновой активности и процессе её выполнения (BackgroundActivityFullInfoAnswer) Краткое описание свойств можно увидеть в документации по ссылке, а основные моменты подробнее описаны здесь.
IsAwaitingAction — если это свойство равно true, то активность приостановлена и ждет действия от пользователя. Следует это учесть, т.к. без действий активность не продолжится.
Actions — список действий, которые пользователь может сейчас совершить в активности. В каждом действии есть его название и идентификатор, который следует передать в метод DoActionForBackgroundActivity. Там всегда есть действие отмены самой активности (Cancel), остальные действия могут появляться по ходу работы активности.
Steps —
...
Выполнить действие для фоновой активности
Когда Фоновая активность ожидает необходимого действия, метод DoActionForBackgroundActivity выполняет это действие для фоновой активности (по сути, отвечает на вопрос, чтобы продолжить процесс).
Принимает:
Аргумент | Тип | Описание |
---|---|---|
instanceKey | String | Ключ экземпляра приложения |
language | String | Язык для запрашиваемых данных |
sessionId | String | Идентификатор сессии |
activityType | String | Тип фоновой активности |
activityId | String | Идентификатор фоновой активности |
actionId | String | Идентификатор действия |
тип и идентификатор фоновой активности, а также идентификатор действия. Доступные действия можно узнать из свойства Actions информации об активности.
Возвращает: не возвращает ничего, кроме ошибок, если таковые есть.
Выполнить действие шага для фоновой активности
Метод DoStepActionForBackgroundActivity
Принимает:
Возвращает : VoidOtapiAnswerВозвращает: VoidOtapiAnswer (при наличии ошибок, выдает информацию о возникших ошибках, в случае отсутствия ошибок не выдает ничего).