tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

Unity

PDF
聚焦模式
字号
最后更新时间: 2025-03-21 21:55:02

功能描述

在使用 Chat SDK 的各项功能前,必须先进行初始化。
大多数场景下,在应用生命周期内,您只需要进行一次 Chat SDK 初始化。

初始化

初始化 SDK 需要操作以下步骤:
1. 准备 SDKAppID。
2. 设置 SdkConfig。
3. 设置 SDK 事件监听器。
4. 调用 Init 初始化 SDK。
下文我们将依次为您详细讲解具体的步骤内容。

准备 SDKAppID

您必须拥有正确的 SDKAppID,才能进行初始化。
SDKAppID 是腾讯云 Chat 服务用于区分客户账号的唯一标识。我们建议每一个独立的 App 都申请一个新的 SDKAppID。不同 SDKAppID 之间的消息是天然隔离的,不能互通。
您可以在 即时通信 Chat 控制台 查看所有的 SDKAppID,单击 创建新应用 按钮,可以创建新的 SDKAppID。

设置 SdkConfig

初始化 SDK 前,您需要初始化一个 SdkConfig 对象。该对象用于设置本地 SDK 缓存、日志位置。
配置即时通信 Chat 运行时的日志、数据的存储路径。

sdk_config_config_file_path

即时通信 Chat 本地数据存储路径。
注意:
该路径需要应用有可读写权限。

sdk_config_log_file_path

即时通信 Chat 日志存储路径。
注意:
该路径需要应用有可读写权限。

调用初始化接口

操作完上述步骤后,您可以调用 Init(点击查看详情) 进行 SDK 初始化。
示例代码如下:
namespace Com.Tencent.IM.Unity.UIKit{
public static void Init() {
string sdkappid = ""; // 从即时通信 IM 控制台获取应用 SDKAppID。
SdkConfig sdkConfig = new SdkConfig();

sdkConfig.sdk_config_config_file_path = Application.persistentDataPath + "/TIM-Config";

sdkConfig.sdk_config_log_file_path = Application.persistentDataPath + "/TIM-Log";

TIMResult res = TencentIMSDK.Init(long.Parse(sdkappid), sdkConfig);
}
}

注册 SDK 全局事件监听

SDK 初始化后,会通过诸如 NetworkStatusListenerCallbackUserSigExpiredCallback 等回调抛出一些事件,例如所示的连接状态、登录票据过期等。 我们建议您在调用 initSDK 后立即注册全局事件监听,在对应回调中做一些逻辑处理。
相关回调如下表所示:
事件回调
事件描述
注册收到新消息回调
设置消息已读回执回调
设置接收的消息被撤回回调
设置消息内元素相关文件上传进度回调
设置群组系统消息回调
设置群组属性变更回调
设置会话未读消息总数变更的回调
设置网络连接状态监听回调
设置被踢下线通知回调
设置票据过期回调
设置添加好友的回调
设置删除好友的回调
设置更新好友资料的回调
设置好友添加请求的回调
设置好友申请被删除的回调
设置好友申请已读的回调
设置黑名单新增的回调
设置黑名单删除的回调
设置日志回调
设置消息在云端被修改后回传回来的消息更新通知回调
获取群消息已读群成员列表
注意:
如果收到 UserSigExpiredCallback 回调,说明您登录用的 UserSig 票据已经过期,请使用新签发的 UserSig 进行重新登录。如果继续使用过期的 UserSig,会导致 Chat SDK 登录进入死循环。

反初始化

普通情况下,如果您的应用生命周期跟 Chat SDK 生命周期一致,退出应用前可以不进行反初始化。
但有些特殊场景,例如您只在进入特定界面后才初始化 Chat SDK,退出界面后不再使用,可以对 Chat SDK 进行反初始化。
反初始化需要操作一个步骤:调用反初始化接口 unInit(点击查看详情)
示例代码如下:
// 反初始化 SDK
TencentIMSDK.Uninit();

其他

调用 SDK 同步返回的结果,当 res 为 TIMResult.TIM_SUCC = 0 时接口调用成功。
在 SDK 初始化成功后,请立即添加需要用到的事件监听,以免消息遗漏。

常见问题

1. 在使用 Chat SDK 登录、消息、群组、会话、关系链和资料、信令的功能前,必须先进行初始化。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈