Steam Web API 库使用文档

1. 安装指南

在开始使用本库之前，请确保你的开发环境已经安装了.NET框架。目前库不再积极维护，建议使用其他库。

2. 项目的使用说明

本.NET库旨在简化Steam Web API的使用。它通过简洁的方法、结构和类封装了所有的JSON数据和API细节。该项目的主要目标是支持Steam好友功能。未来可能会添加购买游戏和物品交易等其他功能。简而言之，它将包含编写跨平台Steam好友消息程序所需的一切。

3. 项目API使用文档

以下是主要类和枚举的描述以及如何使用它们：

枚举

• LoginStatus：认证结果的枚举。
• UserStatus：用户状态的枚举。
• ProfileVisibility：用户资料可见性的枚举。
• AvatarSize：用户头像可用尺寸的枚举。
• UpdateType：可用更新类型的枚举。

主类 - SteamAPISession

此类是您将主要使用到的类，用于管理单个Steam用户的会话。

• LoginStatus Authenticate(string username, string password, string emailauthcode = "")：使用用户名和密码进行认证。如果设置了SteamGuard并且没有传递邮箱验证码，则会发送SteamGuard邮件。
• LoginStatus Authenticate(string accessToken)：使用之前通过用户名和密码（及SteamGuard码）获取的访问令牌进行认证。
• List GetFriends(string steamId = null)：获取指定用户的所有好友的基本信息。
• List GetUserInfo(List steamids)：通过SteamID列表获取用户信息。
• User GetUserInfo(string steamid = null)：获取指定用户的信息。传递null以获取自己的信息。
• Bitmap GetUserAvatar(User user, AvatarSize size = AvatarSize.Small)：以位图形式获取指定用户头像。
• List GetGroups(string steamid = null)：获取指定用户的基本群组信息。
• List GetGroupInfo(List steamids)：通过SteamID列表获取群组信息。
• bool SendTypingNotification(User user)：通知用户你正在输入消息。应该周期性地调用此方法。
• bool SendMessage(User user, string message)：向指定用户发送文本消息。
• List Poll()：检查更新和新消息。
• ServerInfo GetServerInfo()：返回关于服务器的信息。

子类

• Friend：包含基本好友信息的结构体。
• User：包含用户详细信息的结构体。
• Group：包含基本群组信息的结构体。
• GroupInfo：包含群组详细信息的结构体。
• Update：包含单个更新信息的结构体。
• ServerInfo：包含服务器信息的结构体。

4. 项目安装方式

由于本项目不再维护，具体安装方式可能需要根据你的开发环境进行适配。通常情况下，你需要将库的代码集成到你的.NET项目中，并引用相应的类和方法。请参考示例代码进行会话管理和API调用。

以下是一个简单的登录和获取好友数量的示例：

using System;
using SteamWebAPI;

class Program
{
    static void Main(string[] args)
    {
        SteamAPISession session = new SteamAPISession();

        Console.Write("Username: ");
        string username = Console.ReadLine();
        Console.Write("Password: ");
        string password = Console.ReadLine();

        SteamAPISession.LoginStatus status = session.Authenticate(username, password);
        if (status == SteamAPISession.LoginStatus.SteamGuard)
        {
            Console.Write("SteamGuard code: ");
            string code = Console.ReadLine();

            status = session.Authenticate(username, password, code);
        }

        if (status == SteamAPISession.LoginStatus.LoginSuccessful)
        {
            List<SteamAPISession.Friend> friends = session.GetFriends();
            int blockedFriends = friends.Count(f => f.blocked == true);
            Console.WriteLine("你有 " + (friends.Count - blockedFriends) + " 个好友和 " + blockedFriends + " 个屏蔽的好友！");
        }
        else
        {
            Console.WriteLine("登录失败！");
        }
    }
}

请注意，此代码可能需要根据实际库的更新和你的环境进行调整。