Struct ruma_push_gateway_api::send_event_notification::v1::Notification[][src]

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 RawJsonValue>,
    pub counts: NotificationCounts,
    pub devices: &'a [Device],
}
Expand description

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 RawJsonValue>

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

Create a new notification for the given devices.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

The ‘Incoming’ variant of Self.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.