跳到主要内容

快速上手

本教程是为了让新手快速了解融云即时通讯能力库(IMLib)。在本教程中,您可以体验集成 SDK 的基本流程和 IMLib 的基础通信能力。

融云开发者账户

融云开发者账户是使用融云 SDK 产品的必要条件。

在开始之前,请先前往融云官网注册开发者账户。注册后,控制台将自动为您创建一个应用,默认为开发环境应用,使用国内数据中心。请获取该应用的 App Key,在本教程中使用。

提示

App Secret 用于生成数据签名,仅在请求融云服务端 API 接口时使用。本教程中暂不涉及。

如果您已拥有融云开发者账户,您可以直接选择合适的环境,创建应用。

admin-05 docs/unity-imlib/assets/admin/admin-05.png

您需要记录上图所示的应用 App Key,在本教程中使用。

应用的 App Key / Secret 是获取连接融云服务器身份凭证的必要条件,请注意不要泄露。

导入 SDK

  1. 在项目 Assets 目录右键单击选择 Import Package > Custom Package
  2. 选择 RCUnityIMLib.unitypackage 资源包,在 Import Unity Package 对话框选择 All,并执行 Import 导入全部资源。
  3. 在 Unity 项目的 Build Settings 对话框切换当前平台到 iOS 或 Android,然后执行 Build And Run

初始化

在使用 SDK 所有功能之前,必须先调用此方法初始化 SDK。

初始化时需要传入上文获取的 App Key。引擎配置请参见引擎配置

RCIMEngineOptions options = new RCIMEngineOptions();
RCIMEngine engine = RCIMEngine.create(appkey, options);

以上提供了一个简化的初始化示例,关于初始化的更多配置请参见初始化

获取用户 Token

用户 Token 是与用户 ID 对应的身份验证令牌,是应用程序的用户在融云的唯一身份标识。应用客户端在使用融云即时通讯功能前必须与融云建立 IM 连接,连接时必须传入 Token。

在实际业务运行过程中,应用客户端需要通过应用的服务端调用 IM Server API 申请取得 Token。详见 Server API 文档 注册用户

在本教程中,为了快速体验和测试 SDK,我们将使用控制台「北极星」开发者工具箱,从 API 调试页面调用 获取 Token 接口,获取到 userId 为 1 的用户的 Token。提交后,可在返回正文中取得 Token 字符串。

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200,"userId":"1","token":"gxld6GHx3t1eDxof1qtxxYrQcjkbhl1V@sgyu.cn.example.com;sgyu.cn.example.com"}

建立 IM 连接

  1. 设置获取连接状态的监听器:

    engine.onConnected = delegate(int code, string userId)
    {
    // 处理事件
    };
    • code 连接状态码,0 代表连接成功。
    • userId 连接成功的用户 id。
  2. 使用上方获取的 Token,模拟 userId 为 1 的用户连接到融云服务器。

    int code = engine.connect(token, timeout);

监听消息

实现此功能需要开发者实现消息监听回调。

设置消息接收监听器,用于接收所有类型的实时或者离线消息。

  1. message 接收到的消息对象
  2. left 当客户端连接成功后,服务端会将所有补偿消息以消息包的形式下发给客户端,最多每 200 条消息为一个消息包,即一个 Package, 客户端接受到消息包后,会逐条解析并通知应用。left 为当前消息包(Package)里还剩余的消息条数
  3. offline 消息是否离线消息
  4. hasPackage 是否在服务端还存在未下发的消息包
engine.onMessageReceived = delegate(RCIMMessage message,
int left,
bool offline,
bool hasPackage)
{

};

发送消息

RCIMTextMessage textMessage = engine.createTextMessage(type, targetId, channelId, text);
engine.sendMessage(textMessage);

监听消息发送结果

engine.onMessageAttached = delegate(RCIMMessage message)
{

};

engine.onMessageSent = delegate(int code, RCIMMessage message)
{

};

退出登录

engine.disconnect(receivePush);

引擎销毁

engine.destroy();