文档中心

本文介绍如何快速集成环信即时通讯 IM Unity SDK 实现发送和接收单聊文本消息。

技术原理

下图展示在客户端发送和接收单聊文本消息的工作流程。

如上图所示，发送和接收单聊消息的步骤如下：

1. 客户端向你的应用服务器请求 Token，你的应用服务器返回 Token。
2. 客户端 A 和客户端 B 使用获得的 Token 登录环信即时通讯系统。
3. 客户端 A 发送消息到环信即时通讯服务器。
4. 环信即时通讯服务器将消息发送到客户端 B，客户端 B 接收消息。

前提条件

开始前，请确保你的开发环境满足以下条件：

• Unity Editor 2019.4.28 或以上版本
• Unity SDK 1.0.5 或以上
• 目前 Unity SDK 仅支持 x86 指令集及 Intel 芯片。
• 操作系统与编译器要求：

• 有效的环信即时通讯 IM 开发者账号和 App Key，见 环信即时通讯云管理后台 (opens new window)。
• 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。

项目设置

实现发送和接收单聊文本消息之前，参考以下步骤设置你的项目。

1. 下载并设置 Unity Demo 项目

参考以下步骤：

1. 克隆 chat_unity_demo (opens new window)至本地。

2. 打开 Unity Hub，选择 Projects 页签，点击 Open 右边的下拉菜单，选择 Add project from disk，然后选择步骤 1 中本地路径下的 chat_unity_quickstart。这时，Projects 列表中显示 chat_unity_quickstart 项目。

3. 单击 chat_unity_quickstart 打开项目。

   如果正常打开，该流程结束。

2. 集成环信即时通讯 SDK

你可以参考以下步骤集成 SDK：

1. 下载 Unity SDK (opens new window)。
2. 在 Unity Editor 中，选择 Assets > Import Package > Custom Package...，然后选择刚下载的 unitypackage 导入。
3. 在弹出的 Import Unity Package 页面，点击右下角的 Import。

实现发送和接收单聊消息

本节介绍如何使用即时通讯 SDK 在你的 unity 项目中实现发送和接收单聊消息。

1. 打开代码文件进行编辑

在 Unity Editor 中左侧导航栏下方，选择 Project 页签，然后选择 Assets 目录下的 Scripts 目录，双击 TestCode.cs 文件打开 Visual Studio。

以下代码编辑操作均在 Visual Studio 中进行。

2. 添加命名空间

在 TestCode.cs 头部添加以下命名空间：

using AgoraChat; using AgoraChat.MessageBody; 

3. 初始化 SDK

在 InitSDK 方法中添加以下代码完成 SDK 初始化：

var options = new Options("appkey"); //将该参数设置为你的 App Key SDKClient.Instance.InitWithOptions(options); 

4. 创建账号

在 SignUpAction 方法尾部添加以下代码，创建即时通讯系统的登录账户，示例代码如下：

SDKClient.Instance.CreateAccount(username: Username.text, Password.text, callback: new CallBack

( onSuccess: () => { AddLogToLogText("sign up sdk succeed"); }, onError: (code, desc) =>

 { AddLogToLogText($"sign up sdk failed, code: {code}, desc: {desc}"); } )); 

5. 登录账号

在 SignInAction 方法尾部添加以下代码，使用账号登录即时通讯系统，示例代码如下：

SDKClient.Instance.Login(username: Username.text, pwdOrToken: Password.text, callback: new CallBack

( onSuccess: () => { AddLogToLogText("sign in sdk succeed"); }, onError:(code, desc) => 

{ AddLogToLogText($"sign in sdk failed, code: {code}, desc: {desc}"); } )); 

6. 登出账号

在 SignOutAction 方法尾部添加以下代码，登出即时通讯系统，示例代码如下：

SDKClient.Instance.Logout(true, callback: new CallBack( onSuccess: () => { AddLogToLogText

("sign out sdk succeed"); }, onError: (code, desc) => { AddLogToLogText($"sign out sdk

 failed, code: {code}, desc: {desc}"); } )); 

7.发送一条文本消息

在 SendMessageAction 方法尾部添加以下代码，创建和发送一条文本消息，示例代码如下：

Message msg = Message.CreateTextSendMessage(SignChatId.text, MessageContent.text); 

SDKClient.Instance.ChatManager.SendMessage(ref msg, new CallBack( onSuccess: () => 

{ AddLogToLogText($"send message succeed, receiver: {SignChatId.text},  message: 

{MessageContent.text}"); }, onError:(code, desc) => { AddLogToLogText

($"send message failed, code: {code}, desc: {desc}"); } )); 

8.接收消息

接收消息需要对象继承 IChatManagerDelegate 并实现相关的回调方法，同时将对象加入到监听列表中。

示例代码如下：

在类声明的头部继承 IChatManagerDelegate 对象。

public class TestCode : MonoBehaviour, IChatManagerDelegate 

在 TestCode 类内部添加以下回调方法。

由于这里只测试消息接收回调，所以其他回调暂时无需实现，保留空函数即可。

public void OnMessagesReceived(List<Message> messages) { foreach (Message msg in messages) 

{ if (msg.Body.Type == MessageBodyType.TXT) { TextBody txtBody = msg.Body as TextBody;

 AddLogToLogText($"received text message: {txtBody.Text}, from: {msg.From}"); } else if 

(msg.Body.Type == MessageBodyType.IMAGE) { ImageBody imageBody = msg.Body as ImageBody;

 AddLogToLogText($"received image message, from: {msg.From}"); } else if (msg.Body.Type 

== MessageBodyType.VIDEO) { VideoBody videoBody = msg.Body as VideoBody; AddLogToLogText

($"received video message, from: {msg.From}"); } else if (msg.Body.Type == MessageBodyType.VOICE) 

{ VoiceBody voiceBody = msg.Body as VoiceBody; AddLogToLogText($"received voice message, from:

 {msg.From}"); } else if (msg.Body.Type == MessageBodyType.LOCATION) { LocationBody localBody 

= msg.Body as LocationBody; AddLogToLogText($"received location message, from: {msg.From}");

 } else if (msg.Body.Type == MessageBodyType.FILE) { FileBody fileBody = msg.Body as FileBody;

 AddLogToLogText($"received file message, from: {msg.From}"); } } } public void 

OnCmdMessagesReceived(List<Message> messages) { } public void OnMessagesRead(List<Message>

 messages) { } public void OnMessagesDelivered(List<Message> messages) { } public void

 OnMessagesRecalled(List<Message> messages) { } public void OnReadAckForGroupMessageUpdated()

 { } public void OnGroupMessageRead(List<GroupReadAck> list) { } public void OnConversationsUpdate()

 { } public void OnConversationRead(string from, string to) { } public void MessageReactionDidChange

(List<MessageReactionChange> list) { } 

在 AddChatDelegate 方法中添加以下代码，将 TestCode 对象实例加入监听列表。

SDKClient.Instance.ChatManager.AddChatManagerDelegate(this); 

在 RemoveChatDelegate 方法中添加以下代码，在对象释放时将其在监听列表中移除。

SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(this); 

运行和测试项目

在 Unity Editor 的左侧导航栏下方，点击 Project 页签，选择 Assets 下的 Scenes 目录，双击右侧的 SampleScene 场景，然后点击 Unity Editor 上方的 Play 按钮运行场景。