|
|
ru:pro:remoteapi:apiref:messages:load_interval [29/11/2013 12:31] 127.0.0.1 внешнее изменение |
ru:pro:remoteapi:apiref:messages:load_interval [15/05/2014 12:59] |
====== Загрузить сообщения за интервал ====== | |
Чтобы загрузить сообщения за определенный интервал в загрузчик сообщений, нужно использовать команду **messages/load_interval**: | |
<code javascript> | |
svc=messages/load_interval¶ms={"itemId":<long>, | |
"type":<uint>, | |
"ival1":<uint>, | |
"ival2":<uint>, | |
"flags":<uint>, | |
"flagsMask":<uint>, | |
"loadLocations":<bool>, | |
"loadCount":<uint>} | |
</code> | |
| |
//:!: Внимание!// Использование данного запроса рассмотрено в примере [[../../codesamples/messages]]. | |
| |
===== Параметры ===== | |
^ Название ^ Описание ^ | |
| itemId | ID объекта | | |
| type | тип интервала | | |
| ival1 | начало интервала | | |
| ival2 | окончание интервала | | |
| flags | флаги для загружаемых сообщений (см. [[../format/messages | Форматы данных: Сообщения]]) | | |
| flagsMask | маска | | |
| loadLocations | загружать местоположение: 0 - нет, 1 - да | | |
| loadCount | количество сообщений, которое будет загружено (0xffffffff - все найденные) | | |
| |
Типы интервалов: | |
* **1**:\\ ival1 - значение начала интервала (или 0)\\ ival2 - значение окончания интервала (или 0) | |
* **2**:\\ ival1 - количество сообщений, которые будут извлечены от начала или времени, указанного в параметре ival2 | |
* **3**:\\ ival1 - количество сообщений, которые будут извлечены до конца или времени, указанного в параметре ival2 | |
| |
Маски: | |
^ Значение ^ Описание ^ | |
| 0x0F | маска, определяющая тип сообщения с событием | | |
| 0xF0 | маска, определяющая тип сообщения техобслуживания | | |
| 0xFF00 | маска, определяющая тип сообщения | | |
| |
===== Возвращаемый результат ===== | |
<code=javascript> | |
{ | |
"count":<uint>, /* количество найденных сообщений */ | |
"messages":[ /* массив сообщений */ | |
{ | |
... | |
} | |
] | |
} | |
</code> | |
| |
Форматы сообщений рассмотрены в разделе [[../format/messages | Форматы данных: Сообщения]]. | |