• UIKit
  • SDK
  • 服务端 API
Chat/
SDK/
Unity(Game Solution)/
SDK
  • 跑通Demo
  • SDK 集成
  • 初始化
  • 登录和注销
  • 消息
    • 消息概述
    • 发送消息
    • 接收消息
    • 历史消息
    • 转发消息
    • 修改消息
    • 删除消息
    • 清空消息
    • 撤回消息
    • 在线消息
    • 已读回执
    • 查询消息
    • 群 @ 消息
    • 定向群消息
    • 通知免打扰
    • 消息扩展
  • 会话
    • 会话概述
    • 会话列表
    • 获取会话
    • 未读会话数
    • 置顶会话
    • 删除会话
    • 会话草稿
    • 会话标记
    • 会话组
  • 群组
    • 群组概述
    • 群组管理
    • 群资料
    • 群成员管理
    • 群成员资料
    • 自定义群属性
    • 群计数器
  • 用户
    • 用户资料
    • 用户状态
    • 好友管理
    • 好友列表
    • 黑名单
  • Changelog
  • 开发指引
  • 控制台指南
    • 创建和升级应用
    • 基本配置
    • 功能配置
    • 账号管理
    • 群组管理
    • 回调配置
  • 产品介绍
    • 消息管理
      • 单聊消息
      • 消息存储
      • 离线推送
      • 群消息
      • 消息格式
    • 账号系统
      • 登陆验证
      • 在线状态管理
    • 群相关
      • 群组系统
      • 群组管理
    • 用户资料和关系链
      • 资料管理
      • 关系链管理
  • 购买指南
    • 计费概述
    • 价格中心
  • 错误码

初始化

功能描述

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

初始化

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


准备 SDKAppID

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


设置 SdkConfig

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

sdk_config_config_file_path

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

sdk_config_log_file_path

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

调用初始化接口

操作完上述步骤后,您可以调用 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,会导致 IM SDK 登录进入死循环。

反初始化

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

其他

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


常见问题

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