QCloudIM.AspNetCore 是基于 .NET Core / ASP.NET Core 开发,实现腾讯云 IM 服务端 SDK 的调用。.Net Framework 版本请查看: https://github.com/antony10291029/QCloudIMSDK
Package | NuGet |
---|---|
QCloudIM.AspNetCore |
1.引入项目
Install-Package QCloudIM.AspNetCore -Version 1.0.5
2.在 StartUp 中注册并配置参数
services.AddQCloudIM(options =>
{
options.Identifier = "";
options.SdkAppid = "";
options.PrivateKey = "";
// 使用v1版本
//options.Version = "v1";
});
3.使用配置文件的方式设置参数(选项配置)
- 设置配置文件 appsettings.json
{
"QCloudIM": {
"Identifier": "",
"SdkAppid": "",
"PrivateKey": "",
}
}
- 配置选项
services.Configure<QCloudIMOption>(Configuration.GetSection("QCloudIM"));
// v1
// services.Replace(ServiceDescriptor.Singleton<ITlsSignature, TlsSignature>());
4.在业务类中注入对应的 client 并调用。
private IQCloudIMGroupClient _groupClient;
public GroupController(IQCloudIMGroupClient groupClient)
{
_groupClient = groupClient;
}
public async Task<ActionResult<GetGroupListResult>> GetGroupList(GetGroupListRequest request)
{
return await _groupClient.GetGroupListAsync(request);
}
Client 根据腾讯云通信服务端 REST API 定义,接口名称与官方 command 基本一致。官方文档:https://cloud.tencent.com/document/product/269/1520
IQCloudIMGroupClient:群组管理
IQCloudIMConfigClient:全局禁言管理
IQCloudIMDirtywordsClient:脏字管理
IQCloudIMOLoginClient:账号管理
IQCloudIMOpenImClient:消息管理
IQCloudIMProfileClient:资料管理
IQCloudIMSnsClient:关系链管理
IQCloudIMSvcClient:数据下载