Struct rivet_identity::model::GlobalEventNotification

#[non_exhaustive]
pub struct GlobalEventNotification {
    pub title: Option<String>,
    pub description: Option<String>,
    pub thumbnail_url: Option<String>,
    pub url: Option<String>,
}

Notifications represent information that should be presented to the user immediately. At the moment, only chat message events have associated notifications. # Display Notifications should be displayed in an unobtrusive manner throughout the entire game. Notifications should disappear after a few seconds if not interacted with. # Interactions If your platform supports it, notifications should be able to be clicked or tapped in order to open the relevant context for the event. For a simple implementation of notification interactions, open url in a web browser to present the relevant context. For example, a chat message notification will open the thread the chat message was sent in. For advanced implementations that implement a custom chat UI, use rivet.api.identity.common#GlobalEvent$kind to determine what action to take when the notification is interacted with. For example, if the global event kind is rivet.api.identity.common#GlobalEventChatMessage, then open the chat UI for the given thread.

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.

title: Option<String>

description: Option<String>

thumbnail_url: Option<String>

URL to an image thumbnail that should be shown for this notification.

url: Option<String>

Rivet Hub URL that holds the relevant context for this notification.

Implementations

impl GlobalEventNotification

pub fn title(&self) -> Option<&str>

pub fn description(&self) -> Option<&str>

pub fn thumbnail_url(&self) -> Option<&str>

URL to an image thumbnail that should be shown for this notification.

pub fn url(&self) -> Option<&str>

Rivet Hub URL that holds the relevant context for this notification.

impl GlobalEventNotification

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GlobalEventNotification

Trait Implementations

impl Clone for GlobalEventNotification

fn clone(&self) -> GlobalEventNotification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalEventNotification

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

Formats the value using the given formatter.

impl PartialEq<GlobalEventNotification> for GlobalEventNotification

fn eq(&self, other: &GlobalEventNotification) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GlobalEventNotification) -> bool

This method tests for !=.

impl StructuralPartialEq for GlobalEventNotification