Struct Notification

#[non_exhaustive]
pub struct Notification {
    pub event_id: Option<OwnedEventId>,
    pub room_id: Option<OwnedRoomId>,
    pub event_type: Option<TimelineEventType>,
    pub sender: Option<OwnedUserId>,
    pub sender_display_name: Option<String>,
    pub room_name: Option<String>,
    pub room_alias: Option<OwnedRoomAliasId>,
    pub user_is_target: bool,
    pub prio: NotificationPriority,
    pub content: Option<Box<RawValue>>,
    pub counts: NotificationCounts,
    pub devices: Vec<Device>,
}

Available on crate feature api and (crate features push-gateway-api-c or push-gateway-api-s) only.

Type for passing information about a push notification

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.

event_id: Option<OwnedEventId>

The Matrix event ID of the event being notified about.

Required if the notification is about a particular Matrix event. May be omitted for notifications that only contain updated badge counts. This ID can and should be used to detect duplicate notification requests.

room_id: Option<OwnedRoomId>

The ID of the room in which this event occurred.

Required if the notification relates to a specific Matrix event.

event_type: Option<TimelineEventType>

The type of the event as in the event’s type field.

sender: Option<OwnedUserId>

The sender of the event as in the corresponding event field.

sender_display_name: Option<String>

The current display name of the sender in the room in which the event occurred.

room_name: Option<String>

The name of the room in which the event occurred.

room_alias: Option<OwnedRoomAliasId>

An alias to display for the room in which the event occurred.

user_is_target: bool

Whether the user receiving the notification is the subject of a member event (i.e. the state_key of the member event is equal to the user’s Matrix ID).

prio: NotificationPriority

The priority of the notification.

If omitted, high is assumed. This may be used by push gateways to deliver less time-sensitive notifications in a way that will preserve battery power on mobile devices.

content: Option<Box<RawValue>>

The content field from the event, if present.

The pusher may omit this if the event had no content or for any other reason.

counts: NotificationCounts

Current number of unacknowledged communications for the recipient user.

Counts whose value is zero should be omitted.

devices: Vec<Device>

An array of devices that the notification should be sent to.

Implementations

impl Notification

pub fn new(devices: Vec<Device>) -> Notification

Create a new notification for the given devices.

Trait Implementations

impl Clone for Notification

fn clone(&self) -> Notification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Notification

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

Formats the value using the given formatter.

impl Default for Notification

fn default() -> Notification

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Notification

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Notification

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.