Enum PushCondition 

#[non_exhaustive]
pub enum PushCondition {
    EventMatch(EventMatchConditionData),
    ContainsDisplayName,
    RoomMemberCount(RoomMemberCountConditionData),
    SenderNotificationPermission(SenderNotificationPermissionConditionData),
    RoomVersionSupports(RoomVersionSupportsConditionData),
    EventPropertyIs(EventPropertyIsConditionData),
    EventPropertyContains(EventPropertyContainsConditionData),
    ThreadSubscription(ThreadSubscriptionConditionData),
}

A condition that must apply for an associated push rule’s action to be taken.

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.

EventMatch(EventMatchConditionData)

A glob pattern match on a field of the event.

ContainsDisplayName

👎Deprecated

Matches unencrypted messages where content.body contains the owner’s display name in that room.

RoomMemberCount(RoomMemberCountConditionData)

Matches the current number of members in the room.

SenderNotificationPermission(SenderNotificationPermissionConditionData)

Takes into account the current power levels in the room, ensuring the sender of the event has high enough power to trigger the notification.

RoomVersionSupports(RoomVersionSupportsConditionData)

Available on crate feature unstable-msc3931 only.

Apply the rule only to rooms that support a given feature.

EventPropertyIs(EventPropertyIsConditionData)

Exact value match on a property of the event.

EventPropertyContains(EventPropertyContainsConditionData)

Exact value match on a value in an array property of the event.

ThreadSubscription(ThreadSubscriptionConditionData)

Available on crate feature unstable-msc4306 only.

Matches a thread event based on the user’s thread subscription status, as defined by MSC4306.

Implementations

impl PushCondition

pub fn kind(&self) -> &str

Available on crate feature events only.

The value of the kind field for this condition.

pub fn custom_data(&self) -> Option<&Map<String, Value>>

Available on crate feature events only.

The data, if this is a custom condition.

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

Available on crate feature events only.

Check if this condition 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. If the power levels context is missing from it, conditions that depend on it will never apply.

Returns false if this condition is unsupported.

Trait Implementations

impl Clone for PushCondition

fn clone(&self) -> PushCondition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PushCondition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PushCondition

fn deserialize<__D>( __deserializer: __D, ) -> Result<PushCondition, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<EventMatchConditionData> for PushCondition

fn from(value: EventMatchConditionData) -> PushCondition

Converts to this type from the input type.

impl From<EventPropertyContainsConditionData> for PushCondition

fn from(value: EventPropertyContainsConditionData) -> PushCondition

Converts to this type from the input type.

impl From<EventPropertyIsConditionData> for PushCondition

fn from(value: EventPropertyIsConditionData) -> PushCondition

Converts to this type from the input type.

impl From<RoomMemberCountConditionData> for PushCondition

fn from(value: RoomMemberCountConditionData) -> PushCondition

Converts to this type from the input type.

impl From<RoomVersionSupportsConditionData> for PushCondition

Available on crate feature unstable-msc3931 only.

fn from(value: RoomVersionSupportsConditionData) -> PushCondition

Converts to this type from the input type.

impl From<SenderNotificationPermissionConditionData> for PushCondition

fn from(value: SenderNotificationPermissionConditionData) -> PushCondition

Converts to this type from the input type.

impl From<ThreadSubscriptionConditionData> for PushCondition

Available on crate feature unstable-msc4306 only.

fn from(value: ThreadSubscriptionConditionData) -> PushCondition

Converts to this type from the input type.

impl Serialize for PushCondition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.