Module ruma_common::push

source ·
Expand description

Common types for the push notifications module.

Understanding the types of this module

Push rules are grouped in RuleSets, and are grouped in five kinds (for more details about the different kind of rules, see the Ruleset documentation, or the specification). These five kinds are, by order of priority:

  • override rules
  • content rules
  • room rules
  • sender rules
  • underride rules

Structs

Like SimplePushRule, but with an additional conditions field.
Initial set of fields of ConditionalPushRule.
The flattened representation of a JSON object.
Information for a pusher using the Push Gateway API.
A conditional push rule to update or create.
A patterned push rule to update or create.
A simple push rule to update or create.
Like SimplePushRule, but with an additional pattern field.
Initial set of fields of PatterenedPushRule.
The context of the room associated to an event to be able to test all push conditions.
A decimal integer optionally prefixed by one of ==, <, >, >= or <=.
The error type returned when trying modify a push rule that could not be found in a Ruleset.
A push ruleset scopes a set of rules according to some criteria.
Iterator type for Ruleset
Iterator type for Ruleset
A push rule is a single rule that states under what conditions an event should be passed onto a push gateway and how the notification should be presented.
Initial set of fields of SimplePushRule.

Enums

This represents the different actions that should be taken when a rule is matched, and controls how notifications are delivered to the client.
The kinds of push rules that are available.
Reference to any kind of push rule.
One of ==, <, >, >= or <=.
The error type returned when trying to insert a user-defined push rule into a Ruleset.
A push rule to update or create.
The rule IDs of the predefined content server push rules.
The rule IDs of the predefined override server push rules.
The rule IDs of the predefined server push rules.
The rule IDs of the predefined underride server push rules.
A condition that must apply for an associated push rule’s action to be taken.
A special format that the homeserver should use when sending notifications to a Push Gateway. Currently, only event_id_only is supported, see the Push Gateway API.
RoomVersionFeatureunstable-msc3932 and unstable-msc3931
Features supported by room versions.
The kinds of push rules that are available.
The set_tweak action.

Functions

Insert the rule in the given indexset and move it to the given position.