九、帮助 #

#lfeng/wellplay/客户端集成/IOS

帮助系统允许开发者在控制台配置游戏的帮助目录，并结合业务情况在需要时打开帮助时视图。

目前系统仅支持二级目录。

9.1、打开帮助主视图 #

打开帮助视图的首页。

[WPlay showHelpView];

9.2、打开指定路径 #

帮助文档采用树形结构管理，开发者可以通过指定目录路径的方式打开指定文档。

/**
 直接展示帮助文档详情

 @param catalogueArr    需展示的帮助详情所在目录名称数组
 @param failure         打开指定目录失败时的回调，此时会默认打开最匹配的路径，最坏情况下会打开文档首页
 */
[WPlay showHelpDetailViewWithCatalogueArray:@{@""} failure:^(id error) {
        // 未能打开预期的目录（可能是目录名填错了）
    }]

9.2.1、例子 #

假设当前已在后台配置如下目录结构的帮助文档：

—— 新手教程
|—— 注册说明
|—— 登录说明
—— 游戏规则
|—— 技能系统

如果想打开新手教程：

// 此时会转跳到"新手教程"的子目录列表
[WPlay showHelpDetailViewWithCatalogueArray:@{@"新手教程"} failure:^(id error) {
        // 未能打开预期的目录（可能是目录名填错了，或者后台删除了某个目录）
    }]

如果想打开注册说明：

// 此时会转跳到"注册说明"对应的文档。
[WPlay showHelpDetailViewWithCatalogueArray:@[@"新手教程", @"注册说明"] failure:^(id error) {
        // 未能打开预期的目录（可能是目录名填错了，或者后台删除了某个目录）
    }]

如果输入错误（后台并未配置指定的二级目录，但一级目录存在）：

[WPlay showHelpDetailViewWithCatalogueArray:@[@"新手教程", @"不知道什么"] failure:^(id error) {
        // 此时“新手教程”存在
	      // 实际打开“新手教程”，并回调异常
    }]

如果输入错误（后台并未配置指定的一级目录）：

[WPlay showHelpDetailViewWithCatalogueArray:@[@"无敌教程", @"不知道什么"] failure:^(id error) {
        // 此时“无敌教程”存在
	      // 实际打开帮助文档首页，并回调该异常。
    }]