快速上手

快速上手

---

译码小二郎开发者账户

译码小二郎开发者账户是使用译码小二郎 SDK 产品的必要条件。

在开始之前，请先前往译码小二郎官网注册开发者账户。注册后，首先创建一个应用，然后获取该应用的 App Key和App Secret。

App Secret 用于生成数据签名，仅在请求译码小二郎服务端 API 接口时使用。本教程中暂不涉及。

如果您已拥有译码小二郎开发者账户，可以直接创建应用。

admin-05.png

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

应用的 App Key / Secret 是获取连接译码小二郎服务器身份凭证的必要条件，请注意不要泄露。

环境要求

名称	版本
Xcode	11 +
iOS	10.0 +
CocoaPods	1.10.0 +

导入 SDK

1.cd 至项目根目录
2.执行 pod init
3.执行open -e Podfile
4.添加导入配置 pod 'YMIMLib', '~> 0.1.4'，此处以集成 0.1.4 版本为例
5.执行 pod install
6.双击打开 .xcworkspace

初始化

1.导入 SDK 核心类

#import 

2.调用初始化的接口传入从译码小二郎开发者后台获取到的应用 App Key 和App Secret。YMIMClient 类是 YMIMLib SDK 的核心类。所有即时通讯相关方法、监听器都由此调用和设置。

 YMIMConfig *config = [YMIMConfig configWithAppkey:@"译码小二郎 AppKey" appsecret:@"译码小二郎 AppSecret"];
 [[YMIMClient sharedClient] initSDKWithConfig:config];

连接

应用客户端在使用译码小二郎即时通讯功能前必须连接译码小二郎服务器，连接时必须传入 Token 参数。Token 是与用户 ID 对应的身份验证令牌，是应用客户端用户在译码小二郎的唯一身份标识。

在实际业务运行过程中，应用客户端需要通过应用的服务端向译码小二郎服务端申请取得 Token，具体方法可参考 Server API 获取 Token。

在本教程中，为了快速体验和测试 SDK，我们从译码小二郎开发者后台获取一个用户 Token。

1.登录译码小二郎开发者后台，在页面顶部点击应用管理。

2.页面左侧找到 IM 服务，依次点击 API 调用 > 用户服务 > 获取 Token。

3.根据页面提示，填写 UserId，并提交。
在以下示例中，我们将获取到 UserId 为 1 的用户的 Token。

getToken.png

4.使用以上步骤中获取的 Token, 模拟 UserId 为 1 的用户连接到译码小二郎服务器。

 [[YMIMClient sharedClient] loginWithToken: 译码小二郎 token completion:^(YMConnectStatusCode code) {
        if (code == YMConnectSuccess) {
         //连接成功
        }else {
             //无法连接到 IM 服务器，请根据相应的错误码作出对应处理
        }
    }];

SDK 已实现自动重连机制，请参见连接。
调用完连接后，你可以设置连接状态监听来实时监听 IM 连接状态，以便 UI 上给用户以提示，提高体验。

监听连接状态

设置YMIM 连接监听器，用于实时监听 YMIM 连接状态。实现此功能需要开发者遵守 YMConnectionStatusDelegate 协议。
1.在初始化之后，连接之前设置监听器的代理委托。

[YMIMClient sharedClient].connectionStatusDelegate = self;

2.实现代理方法

- (void)onYMConnectionStatusChanged:(YMConnectStatusCode)status {

}

发送消息

向 userId 为 1 的用户发送一条消息。

    YMMessage *message = [[YMMessage alloc]initWithGroupId:@"1" body:[YMTextMessageBody bodyWithText:@"需要发送的文本消息"] ext:nil];
    [[YMIMClient sharedClient].chatManager sendMessage:message completion:^(YMMessage * _Nonnull message, YMErrorCode code) {
        if (code == YM_SUCCESS) {
            NSLog(@"消息发送成功");
            
        }else {
            NSLog(@"消息发送失败");
            
        }
    }];

如果遇到产品相关问题，您可 提交工单 寻求帮助