Struct IdentityPresence

#[non_exhaustive]
pub struct IdentityPresence {
    pub update_ts: Option<i64>,
    pub status: Option<IdentityStatus>,
    pub party: Option<PartyHandle>,
    pub game_activity: Option<IdentityGameActivity>,
}

Information about the identity’s current status, party, and active game.

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.

update_ts: Option<i64>

Time since UNIX epoch (in milliseconds).

status: Option<IdentityStatus>

The current status of an identity. This helps players understand if another player is currently playing or has their game in the background.

party: Option<PartyHandle>

A party handle.

game_activity: Option<IdentityGameActivity>

The game an identity is currently participating in.

Implementations

impl IdentityPresence

pub fn update_ts(&self) -> Option<i64>

Time since UNIX epoch (in milliseconds).

pub fn status(&self) -> Option<&IdentityStatus>

The current status of an identity. This helps players understand if another player is currently playing or has their game in the background.

pub fn party(&self) -> Option<&PartyHandle>

A party handle.

pub fn game_activity(&self) -> Option<&IdentityGameActivity>

The game an identity is currently participating in.

impl IdentityPresence

pub fn builder() -> Builder

Creates a new builder-style object to manufacture IdentityPresence

Trait Implementations

impl Clone for IdentityPresence

fn clone(&self) -> IdentityPresence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityPresence

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

Formats the value using the given formatter.

impl PartialEq for IdentityPresence

fn eq(&self, other: &IdentityPresence) -> 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 IdentityPresence