Message: RuleListResult

File: WebAPI/rules_1.proto

Description

Result of rule list request. If request does not contain ‘subscribe’ field or if it is set to true, this message contains all user’s rules, ‘is_snapshot’ field is set to true. This message is also sent to notify about updated rules if there is active rule list subscription. In this case message contains updated rules only, ‘is_snapshot’ field is omitted. Note: If client received RESULT_CODE_DISCONNECTED result code for rule list subscription for some reason, subscription will be restored later and client will receive a new RuleResult message, containing RESULT_CODE_SUBSCRIBED result code and RuleListResult message with actual list of rules and ‘is_snapshot’ field set to true.

Used in

RuleResult

Fields

rule_definitions

Type: RuleDefinition

Description: Rule list. Clients have to be ready to receive rules that they cannot recognize and ignore them. They must not remove or update unknown rules since they can be used by different applications or different versions of the same application.

is_snapshot

Type: bool

Description: If set to true, rule_definitions contains all found rules. If omitted, rule_definitions contain changed rules only.