steam-user 0.1.0

Steam User web client for Rust - HTTP-based Steam Community interactions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! Notification services.

use crate::{
    client::SteamUser,
    endpoint::steam_endpoint,
    error::SteamUserError,
    types::{Notifications, notifications::NotificationCountsEnvelope},
};

impl SteamUser {
    /// Retrieves the current counts for various Steam notifications.
    ///
    /// This includes unread messages, trade offers, new items, and more.
    ///
    /// # Returns
    ///
    /// Returns a [`Notifications`] struct containing the counts for each type
    /// of notification.
    #[steam_endpoint(GET, host = Community, path = "/actions/GetNotificationCounts", kind = Read)]
    pub async fn get_notifications(&self) -> Result<Notifications, SteamUserError> {
        // Steam returns `{ "notifications": { "1": n, "2": n, ... } }`.
        // Deserialize directly into a typed envelope; missing keys default to 0.
        let envelope: NotificationCountsEnvelope = self.get_path("/actions/GetNotificationCounts").send().await?.json().await?;

        Ok(envelope.notifications.into())
    }
}