Управление событиями элементов системы

Для того чтобы получать события от элементов системы необходимо сначала добавить их в сессию. При исчезновении необходимости слежения за каким-либо элементом, его можно удалить из сессии. Для выполнения данных задач используется команда core/update_data_flags:

svc=core/update_data_flags&params={"spec":[
					{
						"type":<text>,
						"data":<long|text|[long]>,
						"flags":<long>,	
						"mode":<uint>,
						"max_items":<uint>
					}
				   ]}

:!: Использование данного запроса рассмотрено в примере Управление элементами системы и событиями.

Параметры

Название Описание
spec массив объектов с конфигурацией для запроса на изменение элементов, находящихся в сессии
type метод передачи элементов в сессию (см. список ниже)
data данные (зависит от значения предыдущего параметра)
flags флаги, определяющие какая именно информация об элементах будет добавляться в сессию
(флаги каждого типа элемента описаны в разделе Форматы данных)
mode режим применения флагов (см. список ниже)
max_items параметр доступен только при type='type', задаёт максимальное количество подписанных items

Методы передачи элементов:

  • id – по ID, если выбран данный метод, то в параметре data нужно указывать ID элемента;
  • type – по типу, если выбран данный метод, то в параметре data нужно указать тип элементов (см. Поиск элементов);
  • col – по списку ID, если выбран данный метод, то в параметре data нужно указать массив ID интересующих вас элементов.

Pежим применения флагов:

  • 0 – переопределить флаги для указанных элементов;
  • 1 – добавить указанные флаги к уже имеющимся в сессии;
  • 2 – удалить указанные флаги из сессии (при удалении базового флага элемент удаляется из сессии).

Флаги устанавливаются, чтобы следить за изменениями каких-то конкретных свойств элемента. Количество выставленных флагов зависит от ваших нужд, если вам необходимо получать все события, то все флаги должны быть установлены. Получить события можно выполнив запрос из раздела Другие запросы: События.

Возвращаемый результат

[		/*массив элементов*/
	{
		"i":<long>,	/* ID  */
		"d":{		/* другие поля */
			...
		},
		"f":<long>	/* примененные флаги */
	},
	...
]

Формат поля «d» зависит от типа возвращаемого элемента. Форматы всех типов элементов рассмотрены в разделе Форматы данных. При вызове данной команды с режимом применения флагов «2» в поле «d» будет стоять null.

Follow us on Facebook Gurtam Wialon Twitter Gurtam Wialon info@gurtam.com   |   Copyright © 2002-2024 Gurtam