#[non_exhaustive]pub enum AnyPushRuleRef<'a> {
Override(&'a ConditionalPushRule),
Content(&'a PatternedPushRule),
PostContent(&'a ConditionalPushRule),
Room(&'a SimplePushRule<OwnedRoomId>),
Sender(&'a SimplePushRule<OwnedUserId>),
Underride(&'a ConditionalPushRule),
}
Expand description
Reference to any kind of push rule.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Override(&'a ConditionalPushRule)
Rules that override all other kinds.
Content(&'a PatternedPushRule)
Content-specific rules.
PostContent(&'a ConditionalPushRule)
Post-content specific rules.
Room(&'a SimplePushRule<OwnedRoomId>)
Room-specific rules.
Sender(&'a SimplePushRule<OwnedUserId>)
Sender-specific rules.
Underride(&'a ConditionalPushRule)
Lowest priority rules.
Implementations§
Source§impl<'a> AnyPushRuleRef<'a>
impl<'a> AnyPushRuleRef<'a>
Sourcepub fn to_owned(self) -> AnyPushRule
Available on crate feature events
only.
pub fn to_owned(self) -> AnyPushRule
events
only.Convert AnyPushRuleRef
to AnyPushRule
by cloning the inner value.
Sourcepub fn enabled(self) -> bool
Available on crate feature events
only.
pub fn enabled(self) -> bool
events
only.Get the enabled
flag of the push rule.
Sourcepub fn actions(self) -> &'a [Action]
Available on crate feature events
only.
pub fn actions(self) -> &'a [Action]
events
only.Get the actions
of the push rule.
Sourcepub fn triggers_highlight(self) -> bool
Available on crate feature events
only.
pub fn triggers_highlight(self) -> bool
events
only.Whether an event that matches the push rule should be highlighted.
Sourcepub fn triggers_notification(self) -> bool
Available on crate feature events
only.
pub fn triggers_notification(self) -> bool
events
only.Whether an event that matches the push rule should trigger a notification (either in-app or remote / push).
Sourcepub fn triggers_remote_notification(self) -> bool
Available on crate feature events
only.
pub fn triggers_remote_notification(self) -> bool
events
only.Whether an event that matches the push rule should trigger a remote notification.
Sourcepub fn triggers_sound(self) -> Option<&'a str>
Available on crate feature events
only.
pub fn triggers_sound(self) -> Option<&'a str>
events
only.The sound that should be played when an event matches the push rule, if any.
Sourcepub fn rule_id(self) -> &'a str
Available on crate feature events
only.
pub fn rule_id(self) -> &'a str
events
only.Get the rule_id
of the push rule.
Sourcepub fn is_server_default(self) -> bool
Available on crate feature events
only.
pub fn is_server_default(self) -> bool
events
only.Whether the push rule is a server-default rule.
Sourcepub async fn applies(
self,
event: &FlattenedJson,
context: &PushConditionRoomCtx,
) -> bool
Available on crate feature events
only.
pub async fn applies( self, event: &FlattenedJson, context: &PushConditionRoomCtx, ) -> bool
events
only.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§
Source§impl<'a> Clone for AnyPushRuleRef<'a>
impl<'a> Clone for AnyPushRuleRef<'a>
Source§fn clone(&self) -> AnyPushRuleRef<'a>
fn clone(&self) -> AnyPushRuleRef<'a>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more