Struct ActivityPayload 

pub struct ActivityPayload { /* private fields */ }

Represents an immutable activity which has been sent.

Implementations

impl ActivityPayload

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

The name for the activity.

pub fn activity_type(&self) -> Option<ActivityType>

The type of the activity.

pub fn created_at(&self) -> u64

When the activity was created.

Examples found in repository

examples/indefinite.rs (line 21)

async fn main() -> Result<(), PresenceError> {
    let mut runner = PresenceRunner::new("1463450870480900160")
        .on_ready(|data| {
            println!(
                "RPC version: v{}; Connected to user: {}",
                data.version(),
                data.user.global_name().unwrap_or_default(),
            )
        })
        .on_activity_send(|data| {
            println!(
                "Activity sent to app! (running on {})\nCreated at: {}",
                data.platform().unwrap_or_default(),
                data.activity.created_at()
            );
        })
        .on_disconnect(|f| println!("Disconnected: {f:?}"))
        .show_errors() // enables verbose error logging
        .on_retry(move |c| {
            if c % 10 == 0 {
                println!("Retry count {c}; is Discord open?");
            }
        });

    let client = runner.run(true).await?;

    // the activity can include any combination of builder function calls
    let activity = Activity::new()
        .activity_type(ActivityType::Playing)
        .details("epic game")
        .details_url("https://github.com/hitblast")
        .status_display_type(StatusDisplayType::Details)
        .large_image("game_icon")
        .large_text("Playing a game")
        .large_url("https://hitblast.github.io/")
        .small_image("status")
        .small_text("Online")
        .build()?;

    client.set_activity(activity).await?;

    // indefinitely block here
    runner.wait().await?;

    Ok(())
}

pub fn instance(&self) -> Option<bool>

Whether or not the activity is an instance.

pub fn status_display_type(&self) -> Option<StatusDisplayType>

Which element the activity displays as the status (primary text on members banner).

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

The details (top text) for the activity.

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

The URL which the details field redirects to when clicked on.

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

The state (usually the bottom text but could be on top) for the activity.

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

The URL which the state redirects to when clicked on.

pub fn timestamps(&self) -> &TimestampPayload

The timestamp payload object for the activity, containing the start and optionally the end timestamps.

pub fn assets(&self) -> Option<&AssetsPayload>

The assets payload object for the activity, containing all the detials of the assets which were optionally sent with the activity.

pub fn buttons(&self) -> Option<&Vec<ButtonPayload>>

The buttons for the activity. Each button is represented by a ButtonPayload object instance, and returned as a borrowed vector of multiple ButtonPayload objects through this function.

Trait Implementations

impl Clone for ActivityPayload

fn clone(&self) -> ActivityPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActivityPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ActivityPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ActivityPayload

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

where __S: Serializer,

Serialize this value into the given Serde serializer.