Files
TIMSDK/Android/README_ZH.md
T
2024-07-03 18:15:47 +08:00

9.6 KiB

English | 简体中文

本文介绍如何快速跑通即时通信 IM 的体验 Demo。

为尊重表情设计版权,IM Demo/TUIKit 工程中不包含大表情元素切图,正式上线商用前请您替换为自己设计或拥有版权的其他表情包。下图所示默认的小黄脸表情包版权归腾讯云所有,可有偿授权使用,如需获得授权可 提交工单 联系我们。

步骤1:创建应用

  1. 登录即时通信 IM 控制台。

如果您已有应用,请记录其 SDKAppID 并 配置应用。

  1. 在应用管理页面,单击创建新应用,在弹出的对话框中输入应用名称,选择合适的数据中心,单击确定。
  2. 创建完成后,可在应用管理页面查看、搜索、管理应用。请记录 SDKAppID 信息。

步骤2:获取密钥信息

  1. 在应用管理页面的操作中单击查看密钥。
  2. 在弹出的对话框中,单击显示密钥,复制并保存密钥信息。

请妥善保管密钥信息,谨防泄露。

步骤3:下载并配置 Demo 源码

  1. 从 Github 克隆即时通信 IM Demo 工程。
  2. 打开所属终端目录的工程,找到对应的 GenerateTestUserSig 文件。
所属平台 文件相对路径
Android Android/Demo/app/src/main/java/com/tencent/qcloud/tim/demo/signature/GenerateTestUserSig.java
iOS iOS/Demo/TUIKitDemo/Private/GenerateTestUserSig.h
Mac Mac/Demo/TUIKitDemo/Debug/GenerateTestUserSig.h
Windows Windows/Demo/IMApp/GenerateTestUserSig.h
Web(通用) Web/Demo/public/debug/GenerateTestUserSig.js
小程序 MiniProgram/Demo/static/utils/GenerateTestUserSig.js

本文以使用 Android Studio 打开 Android 工程为例。

  1. 设置 GenerateTestUserSig 文件中的相关参数:
  • SDKAPPID:请设置为 步骤1 中获取的实际应用 SDKAppID。
  • SECRETKEY:请设置为 步骤2 中获取的实际密钥信息。

本文提到的获取 UserSig 的方案是在客户端代码中配置 SECRETKEY,该方法中 SECRETKEY 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量,因此该方法仅适合本地跑通 Demo 和功能调试。 正确的 UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端,并提供面向 App 的接口,在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig。

步骤4:编译运行(全部功能)

用 Android Studio 导入工程直接编译运行即可。

Demo 默认集成了音视频通话功能,由于该功能依赖的音视频 SDK 暂不支持模拟器,请使用真机调试或者运行 Demo。

步骤5:编译运行(移除音视频通话)

如果您不需要音视频通话功能,只需要在 app 模块 的 build.gradle 文件中删除音视频通话模块集成代码即可:

api project(':tuicallkit')

操作完上述步骤后会发现,Demo 中的音频通话、视频通话入口均被隐藏。 会话界面屏蔽 TUICallKit 前后的效果:

修改之前 修改之后

联系人资料界面屏蔽 TUICallKit 前后的效果:

修改之前 修改之后

以上演示的仅仅是 Demo 对移除音视频通话功能的处理,开发者可以按照业务要求自定义。

步骤6:编译运行(移除搜索模块)

如果您不需要搜索功能,那么只需要在 app 模块 的 build.gradle 文件中删除下面一行即可:

api project(':tuisearch')

操作完上述步骤后会发现,Demo 中的消息搜索框被隐藏。

消息界面屏蔽 TUISearch 前后的效果:

以上演示的仅仅是 Demo 对移除搜索功能的处理,开发者可以按照业务要求自定义。