快速开始
本文会引导您集成
TUIKit
或 TUIChat
并成功发送第一条消息。开发环境要求
Xcode 10 及以上
iOS 9.0 及以上
创建应用
在集成 TUIKit 之前,您需要先去控制台创建一个新的 Chat 应用,步骤如下:
1. 注册控制台账号。
2. 进入
Application
,单击 Create application
,弹出 application 信息填写框。3. 填写 Application name,选择 product 为 Chat,选择合适的 Region。
操作完成后,您会在
My Applications
列表中看到刚才创建的 application。注意:
请记录下该 application 的 SDKAppID,后续步骤会使用到。另外,请严格保管好 SDKSecretKey,不要透露给无关人员。
操作步骤图示如下:
创建用户账号
创建 application 只能保证您可以正常初始化 SDK。如果要成功发消息,您还需要在 application 中创建用户账号。创建账号方式有很多,例如直接在控制台创建,或者通过 API 在客户端注册,您可以选择任意一种合适的方式。
注意:
发消息至少是两个用户之间进行,因此您在此环节至少要创建 2 个账号。请记录下这 2 个账号的 userID,后续步骤会使用到。
如果您想在控制台创建,步骤如下:
1. 单击进入您上面创建的 application,会在左侧边栏看到 Chat 产品入口,单击进入。
2. 进入 Chat 产品子页面后,单击
Users
,进入用户管理页面。3. 单击
Create account
,弹出创建账号信息填写框。如果只是普通成员,我们建议您选择 General
类型。虽然 Nickname
不是必填项,我们依然建议您设置。如果界面上不方便展示 userID
,您可以通过 Nickname
识别出不同用户。图示如下:
如果你想通过客户端注册,不用额外操作,只需要在下文“登录 TUIKit” 中传入一个全新的
userID
即可,此时 TUIKit 会自动为您注册该 userID
。集成 TUIKit
聊天互动中发送消息的功能是由
TUIChat
实现的,您至少要集成 TUIChat
才能正常收发消息,其他的组件,例如TUIConversation
、TUIContact
、TUIGroup
等,您可以按需集成。如果您需要多个 UI 组件,可以集成 TUIKit,请参见文档:集成 TUIKit。
如果您只需要集成 TUIChat,请参见文档:仅集成聊天。
登录 TUIKit
使用 TUIKit 组件里的功能都需要登录,由 TUILogin 提供登录接口,如下:
// API location: TUICore/TUILogin.h+ (void)login:(int)sdkAppID userID:(NSString *)userID userSig:(NSString *)userSig succ:(__nullable TSucc)succ fail:(__nullable TFail)fail;
该接口要求输入 3 个参数:
sdkAppID,新创建应用的 SDKAppID,已在上文步骤中获取到。
userID,user1 的 userID,已在上文步骤中获取到,注意不是用户的 NickName。
userSig,user1 的 userSig,可使用控制台提供的开发工具实时生成,路径:主页 >
Development Tools
> UserSig Tools
> Signature (UserSig) Generator
,图示如下:
跳转聊天界面
为了实现发消息的目标,接下来要做的是:
1. 使用上述注册的账号之一(下文称之为 user1)登录 TUIKit,此时 user1 上线了。
2. user1 给另一个账号(下文称之为 user2)发消息,user2 可以不登录,跟 user1 可以没有任何好友关系。
说明:
此处讲解的是登录 user1 后给 user2 发消息。如果您希望 user1 和 user2 能聊天互动,需要使用同样的步骤登录 user2 并进入与 user1 的聊天界面。
您可以在 user1 登录成功的回调里跳转或者嵌套聊天界面,就可以给 user2 发消息了。
示例代码如下,其中 userID 需要传入聊天对象 user2 的 userID。
// Pass userID for 1v1 conversation.- (void)pushToChatViewController:(NSString *)groupID userID:(NSString *)userID {// Create conversationData.TUIChatConversationModel *conversationData = [[TUIChatConversationModel alloc] init];conversationData.userID = userID;// Create c2c chatVC.TUIBaseChatViewController_Minimalist *chatVC = [[TUIC2CChatViewController_Minimalist alloc] init];chatVC.conversationData = conversationData;// Option 1: navigate to chatVC.[self.navigationController pushViewController:chatVC animated:YES];// Option 2: add chatVC as a childVC to your parent VC.// [self addChildViewController:vc];// [self.view addSubview:vc.view];}
发送第一条消息
操作完上述步骤,您可以跳转到如下的聊天界面。快点手动单击输入框,发送您的第一条消息吧: