KeyReply
示例
示例应用程序包含在示例
文件夹中。要运行它,首先克隆仓库名,然后首先从示例目录运行pod install
。
KeyReplySDK演示
将KeyReplySDK添加到您的应用中
CocoaPods
要使用CocoaPods安装KeyReply,将以下行添加到您的Podfile
pod 'KeyReply'
手动安装
您还可以将此项目
- 作为git子模块添加
- 简单地下载并将源文件复制到您的项目中
要求
- Xcode 8.0或更高版本
- iOS 8.0或更高版本
用法
Interface Builder
KeyReplySDK可以通过Interface Builder添加到您的视图控制器中
- 将一个普通的UIView拖放到您的视图控制器中
- 将其自定义类设置为
KEYKeyReplyView
类 - 在视图控制器代码中将它连接到一个IBOutlet
- 按照下面的初始化步骤执行
编程式添加KeyReplySDK
KeyReplySDK可以像普通的UIView一样编程式地初始化
CGRect chatFrame = CGRectMake(0, 0, 320, 480);
KEYKeyReplyView * keyReplyView = [[KEYKeyReplyView alloc] initWithFrame:chatFrame];
[self.view addSubview:keyReplyView];
keyReplyView.clientId = @"5f6cc7e4e2";
[keyReplyView reload];
初始化
要使用KeyReplySDK,您需要一个SERVER_URL来获取每个相应的机器人。请直接从KeyReply代表处获取您的SERVER_URL。
KeyReplySDK不会自动加载其内容。每次想要开始使用时,都需要调用reload
函数。通常在提供了所有自定义选项后,在viewDidLoad
函数中进行调用。
[*self*.chatView setServerSetting:@"SERVER_URL"];
[keyReplyView reload];
自定义
加载时折叠
默认情况下,KeyReplySDK在加载时会显示展开的UI。可以通过以下方法禁用此功能:
keyReplyView.autoOpenOnStart = NO;
[keyReplyView reload];
外观
所有的外观自定义应通过KeyReply的Web控制台完成。
APIs
设置服务器URL
[keyReplyView setServerSetting:@"SERVER_URL"];
设置环境URL(WebView URL)
[keyReplyView setEnvUrl:@"ENV_URL"];
设置用户设置
用户设置必须为 NSMutableDictionary
类型。例如
NSMutableDictionary * userDict = [[NSMutableDictionary alloc] init];
[userDict setValue:@"bot1" forKey:@"name"];
[userDict setValue:@"123" forKey:@"id"];
[keyReplyView setUserSetting:(NSMutableDictionary)];
设置 enableAppTokenConfiguredInSetting
此方法用于在设置中设置 appTokenConfigured 属性。例如
[keyReplyView enableAppTokenConfiguredInSetting];
展开/折叠/切换聊天窗口
[keyReplyView openChatWindow];
[keyReplyView closeChatWindow];
[keyReplyView toggleChatWindow];
设置调整大小功能
准备好一个选择器函数,相应地复制并更改框架参数
- (void)chatWindowResize:(NSString *)toggle{
if([toggle isEqualToString:@"true"]) {
self.chatView.frame = self.chatViewFrame;
}else {
CGRect newFrame = CGRectMake(x,y,width,height);
self.chatView.frame = newFrame;
}
}
在 viewDidLoad 方法中调用此方法,如下所示
[self.chatView setChatWindowResizeFunc:@selector(chatWindowResize:) fromObject:self];
此函数将在 openChatWindow 和 closeChatWindow 函数内部调用
设置生成 JWT 函数
[self.chatView setGenerateJWTFunc:@selector(generateJWTFunc:) fromObject:self];
当传递的 JWT 令牌无效时,将调用此函数
使用 JWT 初始化
作为 NSSTRING
接收 JWT 令牌。
[keyReplyView setInitWithJWT:(JWTToken)];
通过编程发送聊天消息
聊天消息可以通过KeyReplySDK UI发送,或者按照以下方式进行编程。
[keyReplyView sendMessage:@"Hello world!"];