Struct PresenceUpdate

#[non_exhaustive]
pub struct PresenceUpdate {
    pub user_id: OwnedUserId,
    pub presence: PresenceState,
    pub status_msg: Option<String>,
    pub last_active_ago: UInt,
    pub currently_active: bool,
}

Available on crate feature api and (crate features federation-api-c or federation-api-s) only.

An update to the presence of a user.

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.

user_id: OwnedUserId

The user ID this presence EDU is for.

presence: PresenceState

The presence of the user.

status_msg: Option<String>

An optional description to accompany the presence.

last_active_ago: UInt

The number of milliseconds that have elapsed since the user last did something.

currently_active: bool

Whether or not the user is currently active.

Defaults to false.

Implementations

impl PresenceUpdate

pub fn new( user_id: OwnedUserId, presence: PresenceState, last_activity: UInt, ) -> PresenceUpdate

Creates a new PresenceUpdate with the given user_id, presence and last_activity.

Trait Implementations

impl Clone for PresenceUpdate

fn clone(&self) -> PresenceUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PresenceUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PresenceUpdate

fn deserialize<__D>( __deserializer: __D, ) -> Result<PresenceUpdate, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PresenceUpdate

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.