Struct discord_game_sdk::Activity

#[repr(transparent)]pub struct Activity(_);

Activity (also known as Rich Presence)

To enable players to join or spectate via invites and requests, some fields are required:

• Joining
  • with_party_id
  • with_party_amount
  • with_party_capacity
  • with_join_secret
• Spectating
  • with_spectate_secret

Struct in official docs

discord.update_activity(
    &Activity::empty()
        .with_state("On Main Menu")
        .with_start_time(now),
    |discord, result| {
        if let Err(error) = result {
            eprintln!("failed to update activity: {}", error);
        }
    },
);

Implementations

impl Activity

pub fn empty() -> Self

Create a new Activity with empty fields

pub fn is_empty(&self) -> bool

Check if an Activity is completely blank

pub fn kind(&self) -> ActivityKind

Type of Activty

pub fn application_id(&self) -> ClientID

The unique ID of the application

pub fn name(&self) -> &str

The name of the application

pub fn state(&self) -> &str

The player's current party status

pub fn details(&self) -> &str

What the player is currently doing

pub fn start_time(&self) -> UnixTimestamp

When the current activity has started, in UNIX Time

pub fn end_time(&self) -> UnixTimestamp

When the current activity will end, in UNIX Time

pub fn large_image_key(&self) -> &str

The key of an asset to display

pub fn large_image_tooltip(&self) -> &str

The tooltip displayed when hovering over the large image

pub fn small_image_key(&self) -> &str

The key of an asset to display

pub fn small_image_tooltip(&self) -> &str

The tooltip displayed when hovering over the small image

pub fn party_id(&self) -> &str

The unique identifier for the party

pub fn party_amount(&self) -> u32

The number of players currently in the party

pub fn party_capacity(&self) -> u32

The maximum capacity of the party

pub fn instance(&self) -> bool

Whether this activity is an instanced context, like a match

pub fn match_secret(&self) -> &str

The unique hash for the given match context

pub fn join_secret(&self) -> &str

The unique hash for chat invites and Ask to Join

pub fn spectate_secret(&self) -> &str

The unique hash for Spectate button

pub fn with_state(&mut self, value: &str) -> &mut Self

The player's current party status

Only the first 128 bytes will be written.

pub fn with_details(&mut self, value: &str) -> &mut Self

What the player is currently doing

Only the first 128 bytes will be written.

pub fn with_start_time(&mut self, value: UnixTimestamp) -> &mut Self

When the current activity has started, in UNIX time

pub fn with_end_time(&mut self, value: UnixTimestamp) -> &mut Self

When the current activity will end, in UNIX time

pub fn with_large_image_key(&mut self, value: &str) -> &mut Self

The key of an asset to display

Only the first 128 bytes will be written.

pub fn with_large_image_tooltip(&mut self, value: &str) -> &mut Self

The tooltip displayed when hovering over the large image

Only the first 128 bytes will be written.

pub fn with_small_image_key(&mut self, value: &str) -> &mut Self

The key of an asset to display

Only the first 128 bytes will be written.

pub fn with_small_image_tooltip(&mut self, value: &str) -> &mut Self

The tooltip displayed when hovering over the small image

Only the first 128 bytes will be written.

pub fn with_party_id(&mut self, value: &str) -> &mut Self

The unique identifier for the party

Only the first 128 bytes will be written.

pub fn with_party_amount(&mut self, value: u32) -> &mut Self

The number of players currently in the party

pub fn with_party_capacity(&mut self, value: u32) -> &mut Self

The maximum capacity of the party

pub fn with_instance(&mut self, value: bool) -> &mut Self

Whether this activity is an instanced context, like a match

pub fn with_match_secret(&mut self, value: &str) -> &mut Self

The unique hash for the given match context

Only the first 128 bytes will be written.

pub fn with_join_secret(&mut self, value: &str) -> &mut Self

The unique hash for chat invites and Ask to Join

Only the first 128 bytes will be written.

pub fn with_spectate_secret(&mut self, value: &str) -> &mut Self

The unique hash for Spectate button

Only the first 128 bytes will be written.

Trait Implementations

impl Clone for Activity

fn clone(&self) -> Activity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Activity

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for Activity

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Activity

impl PartialEq<Activity> for Activity

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

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

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

This method tests for !=.

impl StructuralEq for Activity

impl StructuralPartialEq for Activity