Use_Desk_iOS_SDK
示例
要运行示例项目,先克隆仓库,然后从示例目录中运行 pod install
要求
安装
Use_Desk_iOS_SDK可以通过CocoaPods获取。要安装它,只需将以下行添加到Podfile中
Тестовое приложение
为了运行测试应用,需要进行以下操作
- 克隆仓库
- 打开终端
- 转到已下载的目录(到 Example 文件夹)
- 执行命令 pod install
测试应用截图
将库添加到项目
Use_Desk_iOS_SDK 库通过 CocoaPods 管理系统获取。
- 在您的应用程序 Podfile 中添加一行
pod "Use_Desk_iOS_SDK"
- 在终端中执行命令 pod update
- 连接库 #import "UseDeskSDK.h"
使用参数执行聊天初始化操作
变量 | 类型 | 描述 |
---|---|---|
CompanyID | NSString | 公司标识符 |
NSString | 客户邮箱地址 | |
URL | NSString | 带有端口号的服务器地址 |
块返回以下参数
变量 | 类型 | 描述 |
---|---|---|
Success | BOOL | 连接到服务器的状态 |
Error | NSString | 连接失败时的错误描述 |
示例
[UDS startWithCompanyID:@”1234567” email:@”[email protected]” url:@”https:dev.company.ru” port:@”213” connectionStatus:^(BOOL success, NSString *error) {
}];
使用无图形界面的SDK连接
-
导入库 #import "UseDeskSDK.h"
-
使用无GUI的参数执行初始化聊天操作
变量 | 类型 | 描述 |
---|---|---|
CompanyID | NSString | 公司标识符 |
NSString | 客户邮箱地址 | |
URL | NSString | 服务器地址 |
端口 | NSString | 服务器端口 |
例子
[UDS startWithoutGUICompanyID: :@”1234567” email: @”[email protected]” url: @”https:dev.company.ru:213” connectionStatus:^(BOOL success, NSString *error) {
}];
块返回以下参数
变量 | 类型 | 描述 |
---|---|---|
Success | BOOL | 连接到服务器的状态 |
Error | NSString | 连接失败时的错误描述 |
如果错误类型为noOperators,则当前没有可用的操作员
发送测试消息
变量 | 类型 | 描述 |
---|---|---|
消息 | NSString | 测试消息内容 |
例子
[UDS sendMessage:@”привет как дела?”];
发送带附件的测试消息
变量 | 类型 | 描述 |
---|---|---|
消息 | NSString | 测试消息内容 |
文件名 | NSString | 文件名 |
文件类型 | NSString | 文件类型(MIMO) |
contentBase64 | Base64 | 数据 |
示例
[UDS sendMessage:text withFileName:@"file" fileType:@"image/png" contentBase64:content];
将离线表单发送到服务器
变量 | 类型 | 描述 |
---|---|---|
消息 | NSString | 测试消息内容 |
URL | NSString | 发送地址 |
示例
[UDS sendOfflineFormWithMessage:@”привет” url: @”https:dev.cany.ru” callback:^(BOOL success, NSString *error){
}];
块返回以下参数
变量 | 类型 | 描述 |
---|---|---|
Success | BOOL | 发送状态 |
Error | NSString | 错误类型 |
CallBack – 关于操作的提醒
连接状态
示例
UDS.connectBlock = ^(BOOL success, NSString *error) {
};
模块返回以下参数
变量 | 类型 | 描述 |
---|---|---|
Success | BOOL | 连接状态 |
Error | NSString | 错误类型 |
新消息
变量 | 类型 | 描述 |
---|---|---|
incoming | BOOL | 新消息标志 |
outgoing | BOOL | 出站消息标志 |
text | NSString | 消息文本 |
picture_image | UIImage | 图像 |
Error | NSString | 错误类型 |
示例
UDS.newMessageBlock = ^(BOOL success, RCMessage *message) {
if(message.incoming)
[UDAudio playMessageIncoming];
};
连接状态
UDS.errorBlock = ^(NSArray *errors) {
if(errors.count > 0)
hudErrorConnection.label.text = [errors objectAtIndex:0];
[hudErrorConnection showAnimated:YES];
};
- 操作员已结束对话
模块返回以下参数
变量 | 类型 | 描述 |
---|---|---|
消息 | RCMessage | type为4的消息 - 用户已结束对话 |
示例
UDS.feedbackMessageBlock =^(RCMessage *message) {
};
作者
Maxim, [email protected]
许可协议
Use_Desk_iOS_SDK 在 MIT 许可证下可供使用。更多信息请参阅 LICENSE 文件。