Struct ruma::api::push_gateway::send_event_notification::v1::IncomingNotification [−][src]
pub struct IncomingNotification {
pub event_id: Option<EventId>,
pub room_id: Option<RoomId>,
pub event_type: Option<EventType>,
pub sender: Option<UserId>,
pub sender_display_name: Option<String>,
pub room_name: Option<Box<RoomName, Global>>,
pub room_alias: Option<RoomAliasId>,
pub user_is_target: bool,
pub prio: NotificationPriority,
pub content: Option<Box<RawValue, Global>>,
pub counts: NotificationCounts,
pub devices: Vec<Device, Global>,
}
api
and (crate features push-gateway-api
or push-gateway-api-c
or push-gateway-api-s
) only.Expand description
‘Incoming’ variant of Notification.
Fields
event_id: Option<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<RoomId>
The ID of the room in which this event occurred.
Required if the notification relates to a specific Matrix event.
event_type: Option<EventType>
The type of the event as in the event’s type
field.
sender: Option<UserId>
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<Box<RoomName, Global>>
The name of the room in which the event occurred.
room_alias: Option<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<Box<RawValue, Global>>
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: Vec<Device, Global>
This is an array of devices that the notification should be sent to.
Trait Implementations
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<IncomingNotification, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<IncomingNotification, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for IncomingNotification
impl Send for IncomingNotification
impl Sync for IncomingNotification
impl Unpin for IncomingNotification
impl UnwindSafe for IncomingNotification
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more