update_data_flags

Функция update_data_flags используется для добавления и удаления элементов из сессии. Добавление элементов в сессию необходимо для того, чтобы получать события от них.

Copied!

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

Параметры

Название	Описание
spec	Массив объектов с конфигурацией для запроса на изменение элементов, находящихся в сессии.
type	Метод передачи элементов в сессию: id — по ID. Если выбран этот метод, в параметре data необходимо указать ID элемента. type — по типу. Если выбран этот метод, то в параметре data необходимо указать тип элементов (см. search_items). col — по списку ID. Если выбран этот метод, то в параметре data необходимо указать массив ID интересующих вас элементов. access — подписка на события о создании/удалении, получении/лишении прав доступа items, в параметре data: 1 — включить, 0 — выключить.
data	Данные. Этот параметр зависит от предыдущего.
flags	Флаги, определяющие, какая информация об элементах должна добавляться в сессию. Флаги элементов каждого типа описаны в разделе format.
mode	Режим применения флагов: 0 — переопределить флаги для указанных элементов. 1 — добавить указанные флаги к ужé имеющимся в сессии. 2 — удалить указанные флаги из сессии (при удалении базового флага элемент удаляется из сессии). Флаги устанавливаются для того, чтобы следить за изменениями каких-либо конкретных свойств элемента. Количество установленных флагов зависит от ваших нужд. Если вам необходимо получать все события, то все флаги должны быть установлены. Получить события можно, используя функцию avl_evts.
max_items	Максимальное количество подписанных items. Доступен только при type='type'.

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

Copied!

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

Формат поля “d” зависит от типа возвращаемого элемента. Если при отправке этого запроса указан режим применения флагов “2”, то в поле “d” возвращается значение null. Форматы всех типов элементов описаны в разделе format.

Возможные коды ошибок:

Код	Описание
4	Неверные входные параметры или ошибка при обновлении флагов.

update_data_flags

Параметры

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

Смотрите также