Фоновая активность (фоновый процесс) — используется для процессов, занимающих продолжительное время. Не мешает продолжать работу и отдает идентификатор активности, по которому можно получать информацию о том что в ней происходит (например, прогресс выполнения в %), прервать её или дать интерактивный ответ на возникший в процессе вопрос к оператору, если он есть.
Найти фоновую активность
Метод SearchBackgroundActivities — метод для нахождения фоновых активностей. Необходим, чтобы знать, что сейчас происходит в системе.
Принимает:
Аргумент | Тип | Описание |
---|---|---|
instanceKey | String | Ключ экземпляра приложения |
language | String | Язык для запрашиваемых данных |
sessionId | String | Идентификатор сессии |
xmlSearchParameters | String | Параметры для поиска фоновых активностей (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 | Параметры действия шага ( NamedParameters) |
Возвращает : VoidOtapiAnswer
Выполнить действие для фоновой активности
Когда Фоновая активность ожидает необходимого действия, метод DoActionForBackgroundActivity выполняет это действие для фоновой активности (по сути, отвечает на вопрос, чтобы продолжить процесс).
Принимает:
Аргумент | Тип | Описание |
---|---|---|
instanceKey | String | Ключ экземпляра приложения |
language | String | Язык для запрашиваемых данных |
sessionId | String | Идентификатор сессии |
activityType | String | Тип фоновой активности |
activityId | String | Идентификатор фоновой активности |
actionId | String | Идентификатор действия |
Возвращает: VoidOtapiAnswer (при наличии ошибок, выдает информацию о возникших ошибках, в случае отсутствия ошибок не выдает ничего).