Struct ruma_common::push::ConditionalPushRule

#[non_exhaustive]
pub struct ConditionalPushRule {
    pub actions: Vec<Action>,
    pub default: bool,
    pub enabled: bool,
    pub rule_id: String,
    pub conditions: Vec<PushCondition>,
}

Like SimplePushRule, but with an additional conditions field.

Only applicable to underride and override rules.

To create an instance of this type, first create a ConditionalPushRuleInit and convert it via ConditionalPushRule::from / .into().

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

actions: Vec<Action>

Actions to determine if and how a notification is delivered for events matching this rule.

default: bool

Whether this is a default rule, or has been set explicitly.

enabled: bool

Whether the push rule is enabled or not.

rule_id: String

The ID of this rule.

conditions: Vec<PushCondition>

The conditions that must hold true for an event in order for a rule to be applied to an event.

A rule with no conditions always matches.

Implementations

impl ConditionalPushRule

Default override push rules

pub fn master() -> Self

Matches all events, this can be enabled to turn off all push notifications other than those generated by override rules set by the user.

pub fn suppress_notices() -> Self

Matches messages with a msgtype of notice.

pub fn invite_for_me(user_id: &UserId) -> Self

Matches any invites to a new room for this user.

pub fn member_event() -> Self

Matches any m.room.member_event.

pub fn is_user_mention(user_id: &UserId) -> Self

Matches any message which contains the user’s Matrix ID in the list of user_ids under the m.mentions property.

pub fn contains_display_name() -> Self

👎Deprecated: Since Matrix 1.7. Use the m.mentions property with ConditionalPushRule::is_user_mention() instead.

Matches any message whose content is unencrypted and contains the user’s current display name in the room in which it was sent.

Since Matrix 1.7, this rule only matches if the event’s content does not contain an m.mentions property.

pub fn tombstone() -> Self

Matches any state event whose type is m.room.tombstone. This is intended to notify users of a room when it is upgraded, similar to what an @room notification would accomplish.

pub fn is_room_mention() -> Self

Matches any message from a sender with the proper power level with the room property of the m.mentions property set to true.

pub fn roomnotif() -> Self

👎Deprecated: Since Matrix 1.7. Use the m.mentions property with ConditionalPushRule::is_room_mention() instead.

Matches any message whose content is unencrypted and contains the text @room, signifying the whole room should be notified of the event.

Since Matrix 1.7, this rule only matches if the event’s content does not contain an m.mentions property.

pub fn reaction() -> Self

Matches reactions to a message.

pub fn server_acl() -> Self

Matches room server ACLs.

pub fn suppress_edits() -> Self

Matches event replacements.

pub fn poll_response() -> Self

Matches a poll response event sent in any room.

This rule uses the unstable prefixes defined in MSC3381 and MSC3930.

impl ConditionalPushRule

Default underrides push rules

pub fn call() -> Self

Matches any incoming VOIP call.

pub fn encrypted_room_one_to_one() -> Self

Matches any encrypted event sent in a room with exactly two members.

Unlike other push rules, this rule cannot be matched against the content of the event by nature of it being encrypted. This causes the rule to be an “all or nothing” match where it either matches all events that are encrypted (in 1:1 rooms) or none.

pub fn room_one_to_one() -> Self

Matches any message sent in a room with exactly two members.

pub fn message() -> Self

Matches all chat messages.

pub fn encrypted() -> Self

Matches all encrypted events.

Unlike other push rules, this rule cannot be matched against the content of the event by nature of it being encrypted. This causes the rule to be an “all or nothing” match where it either matches all events that are encrypted (in group rooms) or none.

pub fn poll_start_one_to_one() -> Self

Matches a poll start event sent in a room with exactly two members.

This rule uses the unstable prefixes defined in MSC3381 and MSC3930.

pub fn poll_start() -> Self

Matches a poll start event sent in any room.

This rule uses the unstable prefixes defined in MSC3381 and MSC3930.

pub fn poll_end_one_to_one() -> Self

Matches a poll end event sent in a room with exactly two members.

This rule uses the unstable prefixes defined in MSC3381 and MSC3930.

pub fn poll_end() -> Self

Matches a poll end event sent in any room.

This rule uses the unstable prefixes defined in MSC3381 and MSC3930.

impl ConditionalPushRule

pub fn applies( &self, event: &FlattenedJson, context: &PushConditionRoomCtx, ) -> bool

Check if the push rule applies to the event.

Arguments

• event - The flattened JSON representation of a room message event.
• context - The context of the room at the time of the event.

Trait Implementations

impl Clone for ConditionalPushRule

fn clone(&self) -> ConditionalPushRule

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConditionalPushRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConditionalPushRule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Equivalent<ConditionalPushRule> for str

fn equivalent(&self, key: &ConditionalPushRule) -> bool

Compare self to key and return true if they are equal.

impl From<ConditionalPushRuleInit> for ConditionalPushRule

fn from(init: ConditionalPushRuleInit) -> Self

Converts to this type from the input type.

impl From<NewConditionalPushRule> for ConditionalPushRule

fn from(new_rule: NewConditionalPushRule) -> Self

Converts to this type from the input type.

impl Hash for ConditionalPushRule

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConditionalPushRule

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConditionalPushRule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ConditionalPushRule