DoYouDreamUp - 虚拟助手 iOS SDK

DoYouDreamUp SDK 是一个简单的实现，由 DoYouDreamUp 提供用于通过 websocket 服务器进行实时通信和交换的虚拟助手。

功能

• [x] 简单的 Cocoapods 集成
• [x] 简单访问 Talk、History、Survey、TopQuestions 功能
• [x] 使用 Websocket 进行实时通信
• [x] 使用 Objc 和 Swift 兼容编写
• [x] 兼容 iOS8 & iOS9 & iOS10
• [x] 完整文档

Objective-C 中的用法

a - 头文件

• 在您的 .h 文件中导入头文件

 #import <DoYouDreamUp/DoYouDreamUp.h>

b - 设置

• 在应用程序的 didFinishLaunchingWithOptions 中设置您的令牌和服务器信息

[[DoYouDreamUpManager sharedInstance] configureWithDelegate:self
                     botId:@"972f1264-6d85-4a58-b5ac-da31481dda63"
                     space:nil
                  language:@"FR"
                  testMode:false
              solutionUsed:Assistant
              pureLivechat:false
                 serverUrl:@"wss://jp.createmyassistant.com/servlet/chat"
           backupServerUrl:nil];                       

c - 方法与代理

• 实现 DoYouDreamUpDelegate 协议和其强制方法

///Callback to notify that the connection failed with the given error
///@param error the given error
-(void) dydu_connexionDidFailWithError:(nonnull NSError *)error {}

///Callback to notify that the connection closed correctly
-(void) dydu_connexionDidClosed {}

///Callback to notify that the connection opened
///@param contextId the contextId used in the current connexion
-(void) dydu_connexionDidOpenWithContextId:(nullable NSString*)contextId {}

• 在需要时连接到服务器

[[DoYouDreamUpManager sharedInstance] connect];

• 实现您需要的解决方案（例如谈话）

[[DoYouDreamUpManager sharedInstance] talk:@"Hi, can you help me?"];

• 实现回调代理

-(void) dydu_receivedTalkResponseWithMsg:(nonnull NSString*)message withExtraParameters:(nullable NSDictionary*)extraParameters {}

您已经准备好测试和使用解决方案！在聊天服务周围构建任何 UI。

Swift 中的用法

a - 桥接（如果已完成，则跳过）

• 创建一个新的桥接文件头文件

  Go to File>New>File.. and add a new header file called `[AppNameHere]-Bridging-Header.h.

• 进入 "Build Settings" 并搜索 "Objective-c Bridging Header"。如果尚未定义，请在此处输入桥接头文件路径。

b - 引入头文件

• 将以下行添加到桥接头文件中

  #import <DoYouDreamUp/DoYouDreamUp.h>

c - 设置

• 在application:didFinishLaunchingWithOptions:（Swift 2.3 风格）中设置您的令牌和服务器信息

import DoYouDreamUp

 DoYouDreamUpManager.sharedInstance().configureWithDelegate(self,
                                                            botId: "972f1264-6d85-4a58-b5ac-da31481dda63",
                                                            consultationSpace: nil,
                                                            language: "FR",
                                                            testMode:true,
                                                            solutionUsed: Assistant,
                                                            pureLivechat: false,
                                                            serverUrl:"wss://jp.createmyassistant.com/servlet/chat",
                                                            backupServerUrl:nil)

d - 方法与代理

• 实现 DoYouDreamUpDelegate 协议和其强制方法

///Callback to notify that the connection failed with the given error
///@param error the given error
func dydu_connexionDidFailWithError(error: NSError) {}

///Callback to notify that the connection closed correctly
func dydu_connexionDidClosed() {}

///Callback to notify that the connection opened
///@param contextId the contextId used in the current connexion
func dydu_connexionDidOpenWithContextId(contextId:String?) {}

• 在需要时连接到服务器

DoYouDreamUpManager.sharedInstance().connect()

• 实现您需要的解决方案（例如谈话）

DoYouDreamUpManager.sharedInstance().talk("Hi, can you help me?"])

实现回调代理

func dydu_receivedTalkResponseWithMsg(message: String, withExtraParameters extraParameters: [NSObject : AnyObject]?) {}

您已经准备好测试和使用解决方案！在聊天服务周围构建任何 UI。

演示项目

提供三个演示项目，包括swift & objc。具体包括：

• swift中的cocoapods集成
• objc中的cocoapods集成
• 一个objc中的手动框架集成

安装

推荐使用CocoaPods进行安装，它是Cocoa项目的依赖管理器。Pods可以让您在Xcode项目中下载并集成DoYouDreamUp SDK，耗时不到1分钟。

您可以使用以下命令安装CocoaPods：

$ gem install cocoapods

构建DoYouDreamUp 1.0.0+需要CocoaPods 0.39.0+。

要使用CocoaPods将DoYouDreamUp集成到您的Xcode项目中，请在您的《Podfile》中指定它。

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
pod 'DoYouDreamUp', '~> 1.0.8'

然后，运行以下命令：

$ pod install

其它

接口文档

此SDK是DoYouDreamUp websocket接口的简单包装，您可能需要查阅接口文档。

库组织结构

• DoYouDreamUpFMK：用于构建框架的项目。通过“框架和文档”方案生成了静态的“DoYouDreamUp.framework”。
• DoYouDreamUpFMK_objc：一个与DoYouDreamUpFMK项目关联的依赖项的开发集成项目，使用objc。
• DoYouDreamUpFMK_swift：一个与DoYouDreamUpFMK项目关联的依赖项的开发集成项目，使用swift。
• Examples/DoYouDreamUp_objc_pods：带pod集成的objc示例
• Examples/DoYouDreamUp_objc_manual：带手动集成的objc示例
• Examples/DoYouDreamUp_swift：带pod集成的swift示例
• DoYouDreamUp.framework：生成的框架的最后一个版本
• DOC：本地生成的文档

调试日志

默认情况下不显示日志，除非错误。要启用它，请执行以下操作：

[DoYouDreamUpManager displayLog:true];