Chat Assist SDK 帮助您无缝地将聊天窗口集成到应用程序中,提供实时消息功能和增强用户交互。
关于如何安装项目的说明。
列出需要首先安装的任何先决条件。
- Xcode 15 或更高版本
- CocoaPods(如果 CocoaPods 是包管理器)
- 在 Xcode 中,打开
文件 > 添加包
。 - 搜索 https://github.com/Readyly/chatassist-sdk-ios.git
- 应该列出 ChatAssist。点击
添加包
您可以使用 CocoaPods 安装 ChatAssist
- 要在 Mac 上安装 Cocoapods,在终端中运行
sudo gem install cocoapods
- 将 ChatAssist 添加到 Podfile
use_frameworks!
target 'MyApp' do
pod 'ChatAssist'
end
- 在 Podfile 所在的终端运行
pod install
- 将 ChatAssist 添加到您希望使用的文件中
import ChatAssist
- 通过提供上下文参数初始化 ChatAssist。
orgName
: 组织名称profile
: 聊天配置文件 *可选
let context = Chat.Context(orgName: "help", profile: "christmas")
var chat = try Chat(context: context)
- 开始聊天会话
chat?.startSession()
- 结束聊天会话
chat?.endSession()
- 通过添加
ChatAssistDelegate
观察 Chat 服务器的状态和消息
extension ChatViewModel: ChatAssistDelegate {
public func chatDidReceiveErrorAction(message: String) {
print("Error occured: \(message)")
}
public func chatDidReceiveReadyAction() {
}
public func chatDidReceiveCloseAction() {
}
public func chatDidReceiveExpandAction() {
}
public func chatDidReceiveMinimiseAction() {
}
}
- 发送用户详细信息
有效载荷类型为字典。如果未发送用户详细信息,小部件将在需要时提示用户。
chat?.postMessage(type: .userDetails, payload: ["firstName":"Mauro",
"lastName":"Icardi",
"email":"[email protected]"])
- 发送附加详细信息
有效载荷类型为字典。将附加到会话期间创建的工单中的 details
将被添加到有效载荷中。如果 append
选项为 false
,则任何之前附加的附加详细信息将被覆盖。
chat?.postMessage(type: .additionalDetails, payload: ["details":"diagnostics or relevant details",
"options": ["append":false]])