全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 阿里云办公 培训与认证 物联网

iOS SDK手册

更新时间:2017-09-06 19:00:03

前置准备

在这个集成教程中,我们使用已创建的Demo应用,向您展示如何快速地集成用户反馈组件功能。

一般地,您需要入驻成为开发者并且创建应用后,才能集成反馈功能并且发布您的App。

注意:

  • 您完全可以先跳过前置准备,使用我们预先申请的Demo应用,来完成快速集成。
  • 但是在您正式发布应用之前,您务必将一些内容替换为您所申请应用的特定内容。对于这些需要替换的内容,会在教程中以注意点的形式标识出。
  • 用户反馈SDK支持的系统最低版本为 iOS 7
  • 用户反馈SDK支持 bitcode (bitcode 仅在 Xcode7 及以上显示并默认开启)。
  • 用户反馈SDK及其依赖库均使用 HTTPS协议 进行加密传输。

Step1 下载SDK包

SDK下载地址:https://mhub.console.aliyun.com/#/download

如果您已经获得Demo包,则可以跳过这一步。

Demo地址,打开 Demo 下载页面

Step2 集成SDK

下载SDK并集成

  • 将第一步中下载的文件,直接拖入你的Xcode工程中。参照 Demo 中的做法。
  • 在弹出的对话框中勾选 Copy items if needed 后,点击Finish。

如果遇到 UTDID 冲突可参考:《阿里云-移动云产品SDK UTDID冲突解决方案》

注意: 请确保你Copy过去的目录中包含 YWFeedbackBundle.bundle ,以免造成返回箭头丢失的问题。

使用 Cocoapods 安装 SDK

CocoaPods 安装完成后,还需要在你的项目根目录创建一个 Podfile 文件,添加如下内容:

  1. # 指定 Master 仓库和阿里云仓库
  2. source 'https://github.com/CocoaPods/Specs.git'
  3. source 'https://github.com/aliyun/aliyun-specs.git'
  4. # 添加依赖
  5. target 'YourTargetName' do
  6. pod 'AlicloudFeedback', '~> 3.2.0'
  7. end

(~>为模糊指定版本号方式,~> 3.2.0 表明引用版本位于3.2.0 <= version < 3.3.0之间的最新版本SDK,用户可参考 Podfile Syntax Reference ,根据项目需要指定SDK版本。)

在terminal下运行命令如下:

  1. pod install

已安装旧版的,请运行(不要用–no-repo-update选项):

  1. pod update

如果安装时发现无法找到对应的库,请首先尝试到 CocoaPods 上搜索,如果能够搜索到对应的版本,那就是本地环境的问题,可以尝试运行如下命令:

  1. pod repo update

然后再尝试安装。

命令执行完成后即可完成用户反馈SDK的下载安装。

注意:运行demo前请在 YWLoginController.m文件中填入您的账号信息:

  1. static NSString * const kAppKey = @"******";
  2. static NSString * const kAppSecret = @"******";

Step3 添加依赖系统库

YWFeedbackKit依赖于这些系统库,您需要将他们添加到工程中:

  • 系统公共库:
    • libz.tbd
    • libresolv.tbd
    • libsqlite3.tbd
    • CoreMotion.framework
    • CoreTelephony.framework
    • SystemConfiguration.framework

注意: Cocoapods集成方式不需要手动添加依赖系统库

注意: 在Xcode7之前的版本,没有.tbd的库,而是.dylib

不知道如何添加系统库? 请参考下图:

如何添加系统库

Step4 修改编译选项

Target->Linking->Other Linker Flags中添加 -ObjC 选项。

不知道如何修改编译选项?请参考:

如何修改编译选项

注意:请注意 -ObjC 的大小写。

Step5 iOS 10中隐私权限设置

iOS 10 对隐私权限更加严格,需要添加权限说明(privacy description)。如果不做设置,可能会导致崩溃、审核不通过等情况。设置如下:

在info plist中增加字段:

  1. <key>NSCameraUsageDescription</key>
  2. <string>访问相机</string>
  3. <key>NSPhotoLibraryUsageDescription</key>
  4. <string>访问相册</string>

配置完后如图所示:plist配置完成效果

注意: 上面的访问相机、访问相册可修改。注意: 如果出现点击拍照、相册闪退的问题,请您检查一下,是否添加了权限说明。

Step6 初始化SDK

  • 引入头文件:

    1. #import <YWFeedbackFMWK/YWFeedbackKit.h>
    2. #import <YWFeedbackFMWK/YWFeedbackViewController.h>
  • 调用初始化方法:

    1. /// @brief 初始化方法
    2. /// @params anAppKey AppKey
    3. /// @params anAppSecret AppSecret
    4. /// @return YWFeedbackKit实例
    5. - (instancetype)initWithAppKey:(NSString *)anAppKey appSecret:(NSString *)anAppSecret;
  • 设置业务方扩展的反馈数据:

  1. /// 业务方扩展反馈数据,可设置任意字段,在创建反馈页面前设置,可在后台扩展信息中查看
  2. @property (nonatomic, strong, readwrite) NSDictionary *extInfo;

注意: 请不要将 YWFeedbackKit 实例设置为局部变量,请持有 YWFeedback 实例,以免被提前释放。注意: 由于YWFeedbackKit是个宏,实际上是 BCFeedbackKit,所以在Swift中,请使用 BCFeedbackKit。

Step7 打开反馈页面

  • 调用 YWFeedbackKit 实例如下接口创建反馈界面:

    1. /// @brief 创建反馈页面回调Block
    2. /// @params viewController 反馈页面
    3. /// @return error 调用失败返回错误
    4. typedef void (^YWMakeFeedbackViewControllerCompletionBlock) (YWFeedbackViewController * viewController, NSError *error);
    5. /// @brief 创建反馈页面,默认为不显示弹出错误信息
    6. - (void)makeFeedbackViewControllerWithCompletionBlock:(YWMakeFeedbackViewControllerCompletionBlock)completionBlock;
  • 创建成功后将会返回 YWFeedbackViewController ,你可以根据你App的实际结构,使用Present等不同的方式将其展示。

  • 如果不使用系统默认alert展示错误提示,或者想自行进行错误提示的多语言化,可以自定义提示方式,只需要实现这个block即可。具体可参考 Demo

  1. /// @brief 反馈页面对外抛出Error的回调block。不设置此属性时,将使用默认Alert方式进行错误提示
  2. /// @params viewController 反馈页面
  3. /// @return error 失败error
  4. @property (nonatomic, copy) void (^YWFeedbackViewControllerErrorBlock) (YWFeedbackViewController *viewController, NSError *error);

Step8 获取反馈未读数

  • 调用如下接口获取未读数:

    1. /// @brief 反馈未读消息数回调Block
    2. /// @params unreadCount 未读消息数
    3. /// @return error 调用失败返回错误
    4. typedef void (^YWGetUnreadCountCompletionBlock) (NSInteger unreadCount, NSError *error);
    5. /// @brief 请求反馈未读消息数
    6. - (void)getUnreadCountWithCompletionBlock:(YWGetUnreadCountCompletionBlock)completionBlock;
  • 调用成功后返回反馈未读数,如果返回有未读反馈消息,可在反馈入口添加未读数等方式提醒用户进行查看。

Step9 关闭用户反馈页面

在成功执行Step7后将获取到YWFeedbackViewController,设置属性closeBlock,当用户关闭用户反馈,将调用该block进行dismiss或pop。具体可参考 Demo

  1. [viewController setCloseBlock:^(UIViewController *aParentController){
  2. // 进行 dismiss 或者 pop,以及一些相关设置
  3. [aParentController dismissViewControllerAnimated:YES completion:nil];
  4. }];

Step10 Mobile客户端配置

需要在控制台的 Mobile 客户端配置页面进行配置。

注意: 上述接口在Demo中均有调用演示,具体可参考 Demo

Step11 自定义UI

从 v3.1.0 版本开始增加了自定义UI的接口,包括导航栏字体,导航栏返回按钮的图标。

修改导航栏字体的 API 如下:

  1. //YWFeedbackKit.h
  2. /// @brief 如果不设置,默认为:`[UIFont boldSystemFontOfSize:13]`
  3. @property (nonatomic, strong) UIFont *defaultCloseButtonTitleFont;
  4. /// @brief 如果不设置,默认为:`[UIFont boldSystemFontOfSize:13]`
  5. @property (nonatomic, strong) UIFont *defaultRightBarButtonItemTitleFont;

修改导航栏返回按钮图标的具体方法如下:

如果是手动集成,直接修改 YWFeedbackBundle.bundle 里的图片即可,如果是通过 CocoaPods 方式集成,那么需要修改 YWFeedbackBundle.bundle 命名为 Customized.YWFeedbackBundle.bundle ,并修改 Customized.YWFeedbackBundle.bundle 内部的图片,然后拖拽到你自己的工程项目中即可。

常见错误码

错误码 含义
103 没有加-ObjC,Category没有加载上来。
本文导读目录