帮助中心/文档知识库 IOS SDK

开发者首页 SSO单点登录 Restful API 网页客服组件API IOS SDK 安卓 SDK

文档相关功能设置


                    KFHelpCenter.h

注：用于创建帮助中心文档控制器

参数说明


                    KFHelpCenterType

参数名称	类型	说明
KFHelpCenterTypeDefault	KFHelpCenterType	使用默认,默认使用KFHelpCenterTypeCategory
KFHelpCenterTypeCategory	KFHelpCenterType	展示分区列表
KFHelpCenterTypeForum	KFHelpCenterType	直接展示所有分类列表
KFHelpCenterTypePost	KFHelpCenterType	直接展示所有文档列表

属性说明

属性名称	类型	说明
rightBarType	KFNavBarUIType	rightBarButtonItem的显示方式
rightImageName	NSString	rightBarButtonItem的图片名称
rightTitle	NSString	rightBarButtonItem的标题名称
firstNavigationItemTitle	NSString	第一个控制器的title

方法说明

1、 push知识库文档控制器


                    + (KFDocBaseViewController *)showHelpCenterWithNavController:(UINavigationController*)navController
        helpCenterType:(KFHelpCenterType)helpCenterType;

参数名称	类型	说明
navController	UINavigationController	当前的navController
helpCenterType	KFHelpCenterType	展示方式

2、 push知识库文档控制器(带actionBlock)


                    + (KFDocBaseViewController *)showHelpCenterWithNavController:(UINavigationController*)navController
        helpCenterType:(KFHelpCenterType)helpCenterType
        rightBarButtonActionBlock:(void (^)())actionBlock;

参数名称	类型	说明
navController	UINavigationController	当前的navController
helpCenterType	KFHelpCenterType	展示方式
actionBlock	Block	点击navBar右侧按钮的事件处理，为NULL直接跳转到工单列表

3、 present知识库文档控制器


                    + (KFDocBaseViewController *) presentHelpCenterWithNavController:(UINavigationController*)navController
        helpCenterType:(KFHelpCenterType)helpCenterType;

参数名称	类型	说明
navController	UINavigationController	当前的navController
helpCenterType	KFHelpCenterType	展示方式

4、 present知识库文档控制器(带actionBlock)


                    + (KFDocBaseViewController *) presentHelpCenterWithNavController:(UINavigationController*)navController
        helpCenterType:(KFHelpCenterType)helpCenterType
        rightBarButtonActionBlock:(void (^)())actionBlock;

参数名称	类型	说明
navController	UINavigationController	当前的navController
helpCenterType	KFHelpCenterType	展示方式
actionBlock	Block	点击navBar右侧按钮的事件处理，为NULL直接跳转到工单列表

5、设置右侧NavBarButton的image(自动设置显示方式为KFNavBarUITypeImage)


                    + (void) setConversationsBarButtonImage:(NSString *)name;

参数名称	类型	说明
name	NSString	图片名称

6、设置右侧NavBarButton的内容(自动设置显示方式为KFNavBarUITypeLocalizedLabel)


                    + (void) setConversationsBarButtonTitle:(NSString *)title;

参数名称	类型	说明
title	NSString	内容

7、设置右侧NavBarButton显示方式


                    + (void) setNavBarConversationsUIType:(KFNavBarUIType)type;

参数设置	类型	说明
type	KFNavBarUIType	显示方式,默认为KFNavBarUITypeLocalizedLabel

文档知识库接口


                    KFDocHttpTool.h

注：使用前需要先初始化[KFConfig shareConfig]

属性说明

属性名称	类型	说明
delegate	id	代理对象
type	KFHelpCenterType	列表类型

代理说明

请求成功的代理方法


                    - (void)docHttpTool:(KFDocHttpTool *)docHttpTool successWithResult:(NSDictionary *)result;

请求失败的代理方法


                    - (void)docHttpTool:(KFDocHttpTool *)docHttpTool failureWithError:(KFError *)error;

方法说明

获取列表内容


                    - (NSURLSessionDataTask *)getDocListWithType:(KFHelpCenterType)type
        super_id:(NSString *)super_id
        pageSize:(NSString *)pageSize
        page:(NSString *)page;

参数名称	类型	说明
type	KFHelpCenterType	列表的类型,如:分区,分类,类别
super_id	NSString	上一级的id.如果获取分类的列表,则上级id为分区的id;获取分区的列表,则没有上级id
pageSize	NSString	每页的数量
page	NSString	当前请求第几页

获取文档内容


                    - (NSURLSessionDataTask *)getDocumentWithPost_id:(NSString *)post_id;

参数名称	类型	说明
post_id	NSString	文档的id

搜索文档


                    - (NSURLSessionDataTask *)searchDocumentWithQueryStr:(NSString *)queryStr;

参数名称	类型	说明
queryStr	NSString	搜索关键字

获取文档分区列表


                    + (NSURLSessionDataTask *)getDocCategoriesListWithPageSize:(NSString *)pageSize
        page:(NSString *)page
        successBlock:(KFAPISuccess)successBlock
        failureBlock:(KFAPIError)failureBlock;

参数名称	类型	说明
pageSize	NSString	每页的数量
page	NSString	当前请求第几页
successBlock	KFAPISuccess	获取成功的回调
failureBlock	KFAPIError	获取失败的回调

获取文档分类列表


                    + (NSURLSessionDataTask *)getDocForumListWithCategory_id:(NSString *)category_id
        pageSize:(NSString *)pageSize
        page:(NSString *)page
        successBlock:(KFAPISuccess)successBlock
        failureBlock:(KFAPIError)failureBlock;

参数名称	类型	说明
category_id	NSString	分区的id
pageSize	NSString	每页的数量
page	NSString	当前请求第几页
successBlock	KFAPISuccess	获取成功的回调
failureBlock	KFAPIError	获取失败的回调

获取文档列表


                    + (NSURLSessionDataTask *)getPostListWithForum_id:(NSString *)forum_id
        pageSize:(NSString *)pageSize
        page:(NSString *)page
        successBlock:(KFAPISuccess)successBlock
        failureBlock:(KFAPIError)failureBlock;

参数名称	类型	说明
forum_id	NSString	分类的id
pageSize	NSString	每页的数量
page	NSString	当前请求第几页
successBlock	KFAPISuccess	获取成功的回调
failureBlock	KFAPIError	获取失败的回调

获取文档内容


                    + (NSURLSessionDataTask *)getDocumentWithPost_id:(NSString *)post_id
        successBlock:(KFAPISuccess)successBlock
        failureBlock:(KFAPIError)failureBlock;

参数名称	类型	说明
post_id	NSString	文档的id
successBlock	KFAPISuccess	获取成功的回调
failureBlock	KFAPIError	获取失败的回调

搜索社区问题


                    + (NSURLSessionDataTask *)searchDocumentWithQueryStr:(NSString *)queryStr
        successBlock:(KFAPISuccess)successBlock
        failureBlock:(KFAPIError)failureBlock;

参数名称	类型	说明
queryStr	NSString	搜索关键字
successBlock	KFAPISuccess	获取成功的回调
failureBlock	KFAPIError	获取失败的回调

帮助中心文档列表视图UI设置


KFHelpCenterListView.h

注：设置帮助中心文档列表视图UI, 分区列表,分类列表,文档列表均使用统一样式

属性说明

属性名称	类型	说明
viewBackgroundColor	UIColor	view的背景颜色
tableBackgroundColor	UIColor	tableView的背景颜色
searchBarStyle	NSNumber	searchbar的UIBarstyle
separatorColor	UIColor	tableView的separator颜色
noResultsFoundLabelFont	UIFont	noResultsFoundLabel的字体
noResultsFoundLabelColor	UIColor	noResultsFoundLabel的颜色
noResultsFoundLabelText	NSString	noResultsFoundLabel的提示内容
noResultsFoundLabelBackgroundColor	UIColor	noResultsFoundLabel的背景颜色
cellTextLabelFont	UIFont	cellTextLabel的字体
cellTextLabelColor	UIColor	cellTextLabel的颜色

使用说明：设置相关UI方式同KFCreateRequestView.h。

在线客服电话咨询返回顶部

开发者平台

IOS SDK

SDK说明

SDK FAQ

文档相关功能设置

参数说明

属性说明

方法说明

1、 push知识库文档控制器

2、 push知识库文档控制器(带actionBlock)

3、 present知识库文档控制器

4、 present知识库文档控制器(带actionBlock)

5、设置右侧NavBarButton的image(自动设置显示方式为KFNavBarUITypeImage)

6、设置右侧NavBarButton的内容(自动设置显示方式为KFNavBarUITypeLocalizedLabel)

7、设置右侧NavBarButton显示方式

文档知识库接口

属性说明

代理说明

请求成功的代理方法

请求失败的代理方法

方法说明

获取列表内容

获取文档内容

搜索文档

获取文档分区列表

获取文档分类列表

获取文档列表

获取文档内容

搜索社区问题

帮助中心文档列表视图UI设置

属性说明

IOS SDK

SDK说明

SDK FAQ

文档相关功能设置

参数说明

属性说明

方法说明

1、 push知识库文档控制器

2、 push知识库文档控制器(带actionBlock)

3、 present知识库文档控制器

4、 present知识库文档控制器(带actionBlock)

5、 设置右侧NavBarButton的image(自动设置显示方式为KFNavBarUITypeImage)

6、 设置右侧NavBarButton的内容(自动设置显示方式为KFNavBarUITypeLocalizedLabel)

7、 设置右侧NavBarButton显示方式

文档知识库接口

属性说明

代理说明

请求成功的代理方法

请求失败的代理方法

方法说明

获取列表内容

获取文档内容

搜索文档

获取文档分区列表

获取文档分类列表

获取文档列表

获取文档内容

搜索社区问题

帮助中心文档列表视图UI设置

属性说明

5、设置右侧NavBarButton的image(自动设置显示方式为KFNavBarUITypeImage)

6、设置右侧NavBarButton的内容(自动设置显示方式为KFNavBarUITypeLocalizedLabel)

7、设置右侧NavBarButton显示方式