SDK 集成概述

大约 6 分钟

SDK 集成概述

介绍 React Native 集成相关内容。

前提条件

开始前，请注册有效的环信即时通讯 IM 开发者账号和取得 App key，见 环信即时通讯云管理后台open in new window。

集成环境

具体见 开发环境要求。

增加隐私权限

对于 Android 平台：

  1. 找到文件 android/app/src/main/AndroidManifest.xml
  2. SDK 必需要添加的权限如下：
<!-- access network permissions -->
<uses-permission android:name="android.permission.INTERNET" />
<!-- Get carrier information -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<!-- Wake up permission -->
<uses-permission android:name="android.permission.WAKE_LOCK" />

SDK 初始化

初始化是使用 SDK 的必要步骤，需在所有接口方法调用前完成。如果进行多次初始化操作，只有第一次初始化以及相关的参数生效。初始化的结果通过异步的方式返回。

初始化示例代码：

ChatClient.getInstance()
  .init(
    new ChatOptions({
      appKey: "<your app key>",
      autoLogin: false,
      debugModel: true,
    })
  )
  .then(() => {
    console.log("init success");
  })
  .catch((error) => {
    console.log("init fail: ", error);
  });

初始化参数非常多，这里做主要参数介绍。参数聚合在 ChatOptions 类型中。

  • appKey：App 在控制台注册完成之后会生成该参数，这是 App 在系统中的唯一标识。
  • autoLogin：是否自动登录。该参数设置为 true，则在登录成功之后，后续 App 启动之后自动执行登录操作。如果登录失败会返回错误提示。
  • debugModel：是否启用日志输出功能。设置为 true 则会启用日志输出功能，在调试开发阶段帮助定位和分析问题。
  • acceptInvitationAlways：是否自动接受申请。设置为 true 则当有人申请好友时，自动接受申请。
  • autoAcceptGroupInvitation：是否自动接受邀请。设置为 true 则当有人邀请当前用户入群时，自动接受邀请。
  • requireAck：是否需要发送已读回执。设置为 true 则消息需要已读回执。详见 消息回执章节。
  • requireDeliveryAck：是否需要发送送达回执。设置为 true 则消息需要送达回执。详见消息回执章节。
  • deleteMessagesAsExitGroup：是否需要在离开群组时自动删除聊天历史消息。设置为 true 则在退出群组的时候，会删除聊天记录。
  • deleteMessagesAsExitChatRoom：是否需要在离开聊天室时自动删除聊天历史消息。设置为 true 则在退出聊天室的时候，会删除记录。
  • isChatRoomOwnerLeaveAllowed：是否允许聊天室所有者离开聊天室。设置为 true 则允许。详见 聊天室 章节。
  • isAutoDownload: 是否开启自动下载。设置为 true 则收到图片、视频、音频、语音消息会自动下载。详见 消息 章节。

注册用户

目前注册的方式有以下几种：

  • 通过控制台注册。
  • 通过 REST API 接口注册。
  • 调用 SDK 接口注册。

控制台注册

通过控制台注册用户，详见创建 IM 用户。

REST API 注册

请参考 注册用户。

SDK 注册

若支持 SDK 注册，需登录环信即时通讯云控制台open in new window，选择 即时通讯 > 服务概览，将 设置下的 用户注册模式 设置为 开放注册。

ChatClient.getInstance()
  .createAccount(username, password)
  .then((value: any) => {
    console.log("createAccount: success", value);
  })
  .catch((reason: any) => {
    console.log("createAccount: fail", reason);
  });

提示

该注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用。

用户登录

目前登录服务器有两种方式：

  • 用户 ID + 密码
  • 用户 ID + token

手动登录时传入的用户 ID 必须为 String 类型，支持的字符集详见用户注册的 RESTful 接口。

调用登录接口后，收到 onConnected 回调表明 SDK 与环信服务器连接成功。

用户登录流程详见用户注册与登录的产品说明文档。

手动登录

用户 ID +密码 登录是传统的登录方式。用户名和密码都是你的终端用户自行决定，密码需要符合密码规则要求。

ChatClient.getInstance()
  .login(username, password, true)
  .then((value: any) => {
    console.log(`login success`, value);
  })
  .catch((reason: any) => {
    console.log(`login fail`, reason);
  });

用户 ID + token 是更加安全的登录方式。token 可以通过调用 REST API 获取。 详见 环信用户 token 的获取。

提示

使用 token 登录时需要处理 token 过期的问题，比如在每次登录时更新 token 等机制。

ChatClient.getInstance()
  .login(username, token, false)
  .then((value: any) => {
    console.log(`login success`, value);
  })
  .catch((reason: any) => {
    console.log(`login fail`, reason);
  });

登录重试机制如下：

  • 登录时，若服务器返回明确的失败原因，例如，token 不正确，SDK 不会重试登录。
  • 若登录因超时失败，SDK 会重试登录。

自动登录

在初始化的时候，可以设置是否自动登录。如果设置为自动登录，则登录成功之后，后续启动初始化的时候会自动登录，登录结果异步返回。

自动登录时，SDK 尝试连接服务器失败后，延时随机一段时间后自动重连。

退出登录

登出也是异步返回。

ChatClient.getInstance()
  .logout()
  .then(() => {
    console.log(`logout success`);
  })
  .catch((reason: any) => {
    console.log(`logout fail`, reason);
  });

连接状态相关

你需添加 ChatConnectEventListener#onConnected 回调。

// 监听器建议在初始化完成之后，登录之前设置，这样可以恰当地收到登录通知。
let listener = new (class s implements ChatConnectEventListener {
  onTokenWillExpire(): void {
    // todo: token即将过期
  }
  onTokenDidExpire(): void {
    // todo: token已过期
  }
  onConnected(): void {
    // todo: 已连接到服务器
  }
  onDisconnected(): void {
    // todo: 连接已断开，会自动重连。
  }
  onAppActiveNumberReachLimit?(): void {
    // todo: 达到日活上限，被服务器断开。
  }
  onUserDidLoginFromOtherDeviceWithInfo?(params: {
    deviceName?: string;
    ext?: string;
  }): void {
  // todo: 用户在其它设备登录，本设备被服务器断开。
  }
  onUserDidRemoveFromServer?(): void {
    // todo: 当前用户被移除，被服务器断开。
  }
  onUserDidForbidByServer?(): void {
    // todo: 用户被禁用，被服务器断开。
  }
  onUserDidChangePassword?(): void {
    // todo: 用户权限信息更改，被服务器断开。
  }
  onUserDidLoginTooManyDevice?(): void {
    // todo: 用户登录设备超过上限，被服务器断开。
  }
  onUserKickedByOtherDevice?(): void {
    // todo: 用户被踢下线，被服务器断开。
  }
  onUserAuthenticationFailed?(): void {
    // todo: 用户权限问题，被服务器断开。
  }
  onOfflineMessageSyncStart?(): void {
    // todo: 连接成功，开始从服务器拉取离线消息时触发。
    // 注意：如果本次登录服务器没有离线消息，不会触发该回调。
  }
  onOfflineMessageSyncFinish?(): void {
    // todo: 离线用户上线后从服务器拉取离线消息结束时触发。
   // 注意：如果再拉取离线过程中因网络或其他原因导致连接断开，不会触发该回调。
  }
})();
ChatClient.getInstance().removeAllConnectionListener();
ChatClient.getInstance().addConnectionListener(listener);

断网自动重连

如果由于网络信号弱、切换网络等引起的连接终端，系统会自动尝试重连。重连成功或者失败的结果分别会收到通知 onConnected 和 onDisconnected。

被动退出登录

用户需要关心什么原因被服务器踢下线，需要关注对应事件，并且进行处理。

  • onAppActiveNumberReachLimit:
  • onUserDidLoginFromOtherDeviceWithInfo:
  • onUserDidRemoveFromServer:
  • onUserDidForbidByServer:
  • onUserDidChangePassword:
  • onUserDidLoginTooManyDevice:
  • onUserKickedByOtherDevice:
  • onUserAuthenticationFailed:

输出信息到日志文件

如果开启日志调试模式，会通过控制台输出日志。debugModel 设置为 true。

chatlog.log(`${ChatClient.TAG}: login: `, userName, "******", isPassword);
环信 IM 文档 Version: 1.0.0 ©️环信