Struct GlobalEvent 

#[non_exhaustive]
pub struct GlobalEvent {
    pub ts: Option<DateTime>,
    pub kind: Option<GlobalEventKind>,
    pub notification: Option<GlobalEventNotification>,
}

An event relevant to the current identity.

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.

ts: Option<DateTime>

RFC3339 timestamp.

kind: Option<GlobalEventKind>

Kind of event that occured.

notification: Option<GlobalEventNotification>

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.

Implementations

impl GlobalEvent

pub fn ts(&self) -> Option<&DateTime>

RFC3339 timestamp.

pub fn kind(&self) -> Option<&GlobalEventKind>

Kind of event that occured.

pub fn notification(&self) -> Option<&GlobalEventNotification>

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.

impl GlobalEvent

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GlobalEvent

Trait Implementations

impl Clone for GlobalEvent

fn clone(&self) -> GlobalEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalEvent

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

Formats the value using the given formatter.

impl PartialEq for GlobalEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GlobalEvent