Enum ruma::push::AnyPushRule

#[non_exhaustive]
pub enum AnyPushRule {
    Override(ConditionalPushRule),
    Content(PatternedPushRule),
    Room(SimplePushRule<OwnedRoomId>),
    Sender(SimplePushRule<OwnedUserId>),
    Underride(ConditionalPushRule),
}

The kinds of push rules that are available.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Override(ConditionalPushRule)

Rules that override all other kinds.

Content(PatternedPushRule)

Content-specific rules.

Room(SimplePushRule<OwnedRoomId>)

Room-specific rules.

Sender(SimplePushRule<OwnedUserId>)

Sender-specific rules.

Underride(ConditionalPushRule)

Lowest priority rules.

Implementations

impl AnyPushRule

pub fn as_ref(&self) -> AnyPushRuleRef<'_>

Convert AnyPushRule to AnyPushRuleRef.

pub fn enabled(&self) -> bool

Get the enabled flag of the push rule.

pub fn actions(&self) -> &[Action]

Get the actions of the push rule.

pub fn triggers_highlight(&self) -> bool

Whether an event that matches the push rule should be highlighted.

pub fn triggers_notification(&self) -> bool

Whether an event that matches the push rule should trigger a notification.

pub fn triggers_sound(&self) -> Option<&str>

The sound that should be played when an event matches the push rule, if any.

pub fn rule_id(&self) -> &str

Get the rule_id of the push rule.

pub fn is_server_default(&self) -> bool

Whether the push rule is a server-default rule.

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 AnyPushRule

fn clone(&self) -> AnyPushRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnyPushRule

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

Formats the value using the given formatter.

impl From<AnyPushRule> for PushRule

fn from(push_rule: AnyPushRule) -> PushRule

Converts to this type from the input type.