Struct ruma::api::push_gateway::send_event_notification::v1::Notification

pub struct Notification<'a> {
    pub event_id: Option<&'a EventId>,
    pub room_id: Option<&'a RoomId>,
    pub event_type: Option<&'a EventType>,
    pub sender: Option<&'a UserId>,
    pub sender_display_name: Option<&'a str>,
    pub room_name: Option<&'a RoomName>,
    pub room_alias: Option<&'a RoomAliasId>,
    pub user_is_target: bool,
    pub prio: NotificationPriority,
    pub content: Option<&'a RawValue>,
    pub counts: NotificationCounts,
    pub devices: &'a [Device],
}

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

Type for passing information about a push notification

Fields

event_id: Option<&'a EventId>

The Matrix event ID of the event being notified about.

This is required if the notification is about a particular Matrix event. It 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<&'a RoomId>

The ID of the room in which this event occurred.

Required if the notification relates to a specific Matrix event.

event_type: Option<&'a EventType>

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

sender: Option<&'a UserId>

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

sender_display_name: Option<&'a str>

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

room_name: Option<&'a RoomName>

The name of the room in which the event occurred.

room_alias: Option<&'a RoomAliasId>

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

user_is_target: bool

This is true if 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<&'a 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

This is a dictionary of the current number of unacknowledged communications for the recipient user. Counts whose value is zero should be omitted.

devices: &'a [Device]

This is an array of devices that the notification should be sent to.

Implementations

impl<'a> Notification<'a>

pub fn new(devices: &'a [Device]) -> Notification<'a>

Create a new notification for the given devices.

Trait Implementations

impl<'a> Clone for Notification<'a>

pub fn clone(&self) -> Notification<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Notification<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Notification<'a>

pub fn default() -> Notification<'a>

Returns the “default value” for a type.

impl<'a> Outgoing for Notification<'a>

type Incoming = IncomingNotification

The ‘Incoming’ variant of Self.

impl<'a> Serialize for Notification<'a>

pub 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.