Use_Desk_iOS_SDK
示例
要运行示例项目，请首先克隆仓库，然后从 Example 目录中运行 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 | 连接失败时的错误描述 |
示例
UseDeskSDK * usedesk = [[UseDeskSDK alloc] init];
[usedesk 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 | 服务器端口 |
示例
UseDeskSDK * usedesk = [[UseDeskSDK alloc] init];
[usedesk startWithoutGUICompanyID: :@”1234567” email: @”[email protected]” url: @”https:dev.company.ru:213” connectionStatus:^(BOOL success, NSString *error) {
}];返回以下参数
| 变量 | 类型 | 描述 |
|---|---|---|
| Success | BOOL | 连接到服务器的状态 |
| Error | NSString | 连接失败时的错误描述 |
如果错误类型为 noOperators，则当前没有可用的操作员
发送测试消息
| 变量 | 类型 | 描述 |
|---|---|---|
| 消息 | NSString | 测试消息 |
示例
[self.usedesk sendMessage:@”привет как дела?”];发送包含附件的测试消息
| 变量 | 类型 | 描述 |
|---|---|---|
| 消息 | NSString | 测试消息 |
| 文件名 | NSString | 文件名 |
| fileType | NSString | 文件类型 (MIMO) |
| contentBase64 | Base64 | 数据 |
示例
[self.usedesk sendMessage:text withFileName:@"file" fileType:@"image/png" contentBase64:content];将离线表单发送到服务器
| 变量 | 类型 | 描述 |
|---|---|---|
| 消息 | NSString | 测试消息 |
| URL | NSString | 发送地址 |
示例
[self.usedesk sendOfflineFormWithMessage:@”привет” url: @”https:dev.cany.ru” callback:^(BOOL success, NSString *error){
}];模块返回以下参数
| 变量 | 类型 | 描述 |
|---|---|---|
| Success | BOOL | 发送状态 |
| Error | NSString | 错误类型 |
Callback – 动作通知
连接状态
示例
self.usedesk.connectBlock = ^(BOOL success, NSString *error) {
};块返回以下参数
| 变量 | 类型 | 描述 |
|---|---|---|
| Success | BOOL | 连接状态 |
| Error | NSString | 错误类型 |
新进入的消息
| 变量 | 类型 | 描述 |
|---|---|---|
| incoming | BOOL | 进入消息标志 |
| outgoing | BOOL | 发出消息标志 |
| text | NSString | 消息文本 |
| picture_image | UIImage | 图像 |
| Error | NSString | 错误类型 |
示例
self.usedesk.newMessageBlock = ^(BOOL success, RCMessage *message) {
if(message.incoming)
[UDAudio playMessageIncoming];
};连接状态
self.usedesk.errorBlock = ^(NSArray *errors) {
if(errors.count > 0)
hudErrorConnection.label.text = [errors objectAtIndex:0];
[hudErrorConnection showAnimated:YES];
};- 操作员已完成对话
块返回以下参数
| 变量 | 类型 | 描述 |
|---|---|---|
| 消息 | RCMessage | type为4的消息 - 用户已完成对话 |
示例
self.usedesk.feedbackMessageBlock =^(RCMessage *message) {
};作者
Maxim, [email protected]
许可协议
Use_Desk_iOS_SDK 适用于 MIT 许可协议。有关更多信息，请参阅 LICENSE 文件。