Quickstart

快速在项目中使用 WxConnector进行开发

在 DotNet Core 项目中进行使用

在项目中引用

我们为 DotNet Core 项目提供了专用的 Nuget 包进行使用

包的Nuget仓库地址

我们可以使用Nuget包管理器在项目中引用本包

NuGet\Install-Package WxConnectorLib

也可以使用 DotNet Cli

dotnet add package WxConnectorLib

之后就可以使用本包进行开发了喵~

简单示例

// 引入需要的命名空间
using WxConnectorLib.Managers;
using WxConnectorLib.Utils;

// ActionUtil封装了操作类的方法
// 使用ActionUtil进行操作

// LoginAction会使用传入的exe路径启动微信并等待登录
ActionUtil.Get().LoginAction(@"C:\Program Files\Tencent\WeChat\WeChat.exe");

// OpenListenerWindowsAction对传入的用户打开独立监听窗口
// 并返回监听窗口列表(这里传入的字符串是好友备注名和群名)
var listeners = ActionUtil.Get().OpenListenerWindowsAction(["测试用户", "测试机器人群聊"]);

// MessageUtil 是用于格式化和处理消息的方法类,有关处理消息的方法封装于此
// 设置一些消息的保存路径(如文件、图片等)
MessageUtil.Get().SetSavePath(".data");

// ListenManager 类是监听器管理器,封装了监听方法,用于启动监听
// 使用ListenManager类进行消息监听(传入需要监听的窗口)
ListenManager.Get().InitListen(listener)

// EventManager 类封装了一些与消息有关的 Event
// 使用EventManager类来挂载事件处理函数
EventManager.Get().OnNewMessage += (message, chatWindow) => Console.WriteLine($"从{chatWindow.Title}收到消息:{message}");

// ActionUtil类提供了发送文字消息与文件消息的方法
// window参数指定了需要向哪一个用户独立监听窗口发送消息
// 可以从事件处理函数中获取到,也可以从OpenListenerWindowsAction中获取
ActionUtil.Get().SendTextMessage("这是一条测试文字消息", window);

更多方法请查看渐进式文档

在非 DotNet Core 项目中进行使用

注意,渐进式文档中的是 WxConnectorLib 的文档,而 WxConnectorProvider 和 SDK 的版本更新会慢于渐进式文档,在下面 "使用 api 进行开发"部分 与 "使用 sdk 进行开发" 部分中我会写明 sdk 与 provider 同步的 WxConnectorLib 版本(与这个版本的功能同步)

对于非 DotNet Core 项目,我们提供了一个对 win-x64 平台进行构建的 WxConnectorProvider,用于使用 网络IO 对封装的 WeChat 模拟操作进行访问

安装依赖

WxConnectorProvider 依赖于 DotNet Runtime 8.0.x

获取DotNet Runtime

访问本URL页面中的 ".NET Runtime 8.0.xx" 项中的 "Installers" 中点击 "x64" 进行获取

安装 Provider 主体

前往 WxConnectorProvider 仓库中 Release 区 获取最新的二进制构建安装包

获取 WxConnectorProvider Release

选择任意路径安装即可

安装路径经可能不要放在无权限访问的文件夹 如:Program Files、Program Files (x86)

安装路径也经可能不要有中文

使用 api 进行开发

与 WxConnectorLib v 0.1.1 部分功能同步

(这里消息引用因为对象传递的问题暂时没有同步)

可以在 WxConnectorProvider 的 README 中找到 最新的 Api文档

ReadMe

如果认为使用http和websocket进行开发太过麻烦,可以参考下面的使用sdk进行开发

使用 sdk 进行开发

与 WxConnectorProvider v 0.1.1 功能同步

项目当前支持 python sdk

python sdk

请参考对应 sdk 中的 ReadMe 在项目中进行引用和开发 开发文档请参考 SDK 文档

Last updated