集成方法

1、CocoaPods

source 'https://github.com/CocoaPods/Specs.git'platform :ios, '8.0'target 'TargetName' do    pod 'KF5SDK', '~>2.9.1'end

2、Carthage

github "KF5SDK/KF5SDK-iOS2.0" ~>2.9.1

3、手动集成

  1. 先下载KF5SDK的官方demo。将KF5SDK下的文件拖拽到自己的工程中。

  2. 添加系统库支持,添加JavaScriptCore.framework,libsqlite3.tbd到自己的工程。
    addSystemLibraries.png

    注意:SDK需要使用以下权限,进入工程中的info.plist,添加以下权限

    Privacy - Camera Usage Description:是否允许该应用使用你的相机?
    Privacy - Microphone Usage Description:是否允许该应用使用你的麦克风?
    Privacy - Photo Library Usage Description:是否允许该应用访问你的媒体资料库?


使用方法

1、首先需要引入 #import "KF5SDK.h"

在使用SDK相关功能模块前,需要先设置KF5平台域名和appid,并调用KFUserManager的初始化用户的方法获取到userToken(用户唯一标示),下面为使用邮箱初始化用户的方法:

// 初始化配置信息[KFUserManager initializeWithHostName:kHostName appId:kAppId];  // 如果userToken为空,则需要初始化用户if ([KFUserManager shareUserManager].user.userToken.length == 0) {    [[KFUserManager shareUserManager]initializeWithEmail:@"123@qq.com" completion:^(KFUser * _Nullable user, NSError * _Nullable error) {    }];}

注意:

1、[KFUserManager initializeWithHostName:kHostName appId:kAppId]中khostName为您平台的http地址,如:https://tianxiang.kf5.com, kAppId为您为用户创建的唯一标示(在您的KF5后台创建移动SDK APP应用,APP应用里的传输密钥即为appId)。此方法可放在AppDelegate里初始化。

2、最好在使用SDK相关功能前调用,比如设置界面,不建议在AppDelegate中调用此方法,因为当前服务器对每个平台平均的创建用户量有一定的限制。KF5SDK是专用于普通用户的,因此初始化用户时应该使用不同的邮箱或手机号,否则App中的每个用户看到的所有信息全部相同。

2、添加支持文档功能

引入#import "KF5SDKDoc.h"
调用方法如下:

[self.navigationController pushViewController:[[KFCategoryListViewController alloc]init] animated:YES];

注:文档部分有文档分区、文档分类、文档列表、文档内容,分别对应控制器为KFCategoryListViewControllerKFForumListViewControllerKFPostListViewControllerKFDocumentViewController。更详细的信息请见相关类的头文件。

3、添加支持工单功能

引入#import "KF5SDKTicket.h"
调用方法如下:

[self.navigationController pushViewController:[[KFTicketListViewController alloc]init] animated:YES];

工单自定义字段需要在创建工单前设置,对应方法为KFCreateTicketViewController中的setCustomFields方法,格式为@[@{@"name":@"field_123",@"value":@"手机端"},@{@"name":@"field_321",@"value":@"iOS"}]。

注:工单部分有工单列表、工单内容、创建工单、工单详细信息,分别对应控制器为KFTicketListViewControllerKFTicketViewControllerKFCreateTicketViewControllerKFDetailMessageViewController。更详细的信息请见相关类的头文件。

4、添加支持即时通讯功能

引入#import "KF5SDKChat.h"
调用方法如下:

[self.navigationController pushViewController:[[KFChatViewController alloc]initWithMetadata:@[@{@"name":@"系统",@"value":@"IOS"},@{@"name":@"应用名称",@"value":@"云客服"}]] animated:YES];

用户自定义信息需要在初始化KFChatViewController时设置,在initWithMetadata:中设置metadata,格式为@[@{@"name":@"系统",@"value":@"IOS"},@{@"name":@"应用名称",@"value":@"云客服"}]。

注:聊天部分有聊天控制器,对应控制器为KFChatViewController。更详细的信息请见相关类的头文件。