HPWVisitorSDK 3.3.1

HPWVisitorSDK 3.3.1

×

由 71sino 维护。

HPWVisitorSDK 3.3.1

  • 作者
  • 71sino

智八哥 iOS访客端 SDK 开发指南

SDK 版本 日期
iOS HPWVistor3.3.0 2018-3-28

要求

iOS8.0 和Xcode 9以上

一、简介

智八哥访客端是一个SDK，允许客户将其嵌入到应用程序中。只需传入 commpanyCode 和 appkey，访客和客服人员就可以进行聊天。同时为开发者提供了简单、易于使用的API接口，方便快速集成。

二、 接入准备

（1）获取 commpanyCode和 AppKey

请前往 http://www.71chat.com/ 进行注册以获取AppKey 和 commpanyCode。

（2）下载访客端SDK，解压缩。注：使用CocoaPods的用户可以通过如下名称管理智八哥：

pod 'HPWVisitorSDK', '~> 3.3.0'
注意（在终端更新pod之后搜索）
rm ~/Library/Caches/CocoaPods/search_index.json
Pod setup

（3）将以下所有文件添加到工程

配置图1

（4）配置依赖库。点击项目的TARGETS General link Binary With Libraries 添加libxml2.2.tbd、libsqlite3.0.tbd、libz.tbd、UserNotifications.framework、CoreTelephony.framework。示例图如下

配置图1

（5）点击项目的TARGETS Build Settings Linking Other Linker Flags 添加–ObjC: 如果出现编译duplicate symbols for architecture等类似错误，请检查Other Linker Flags中是否包含-force_load, -all_load，如果包含，需要删除掉才能编译成功。

三、代码集成

（1）将公司信息注册到SDK

    [[HPWVistor sharedVistor] registerCommpanyCode:@"你注册公司id"
                                            appkey:@"你配置的公司appkey"
                                       environment:HPWEnvironmentTypeRelease];

（2）在视图控制器中调用SDK

//3、弹出访客端界面
[[HPWVistor sharedVistor] showView:self dismissCompletion:^{
NSLog(@"SDK视图关闭");
} errorFail:^{
NSLog(@"出现网络错误");
}];

（3）异步查询会话的未读数

/**
查询未读数
*/
- (void)queryUnreadNumMessageSucceed:(void (^)(NSInteger num))block;

（4）添加用户轨迹事件

/**
用户轨迹记录
@param curUrl 当前浏览页面
@param pageTitle 当前浏览页面标题
@param resolution 手机分辨率
@param sourceUrl 浏览器类型
@param success 提交成功
@param fail 提交失败
*/
- (void)addTrajectoryInfo:(NSString *)curUrl
pageTitle:(NSString *)pageTitle
resolution:(NSString *)resolution
sourceUrl:(NSString *)sourceUrl
result:(void (^)())success fail:(void (^)())fail;

（5）将访客的唯一标识传输到SDK

/**
设置访客的唯一标示到SDK
*/
- (void)setPartnerUid:(NSString *)partnerUid;

四、部分控件颜色、图片自定义

（1）在HappyWinBundle.bundle中修改图片

（2）修改控件颜色，请在HPWVistorSDKConfig.h中修改

五、注意事项

（1）如果项目中包含IQKeyboardManager，需要在调用showView: dismissCompletion之前禁用IQK的功能，然后在Dismissblock回调或者fail时启用IQK。

（2）在Xcode 9.x中，由于导入的第三方库和bundle可能不会自动加入编译过程，因此需要手动拖入。

（3）在项目中开启摄像头、相册、麦克风权限。

<key>NSCameraUsageDescription</key>
<string>App需要您的同意,才能访问相机</string>
<key>NSMicrophoneUsageDescription</key>
<string>是否允许此App使用你的麦克风？</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>App需要您的同意,才能访问相册</string>