iOS SDK 集成指南

1. 由于苹果 App Store 审核政策的原因，目前禁止使用含有自动更新功能（或可能含有）的 App 上架。虽然蒲公英主 SDK 已经完全去掉了自动更新功能，但是由于苹果 App Store 审核政策不明确、通常碰运气因素比较大的原因，为了保证开发者在运气不好的时候也能通过审核，所以，请开发者在提交苹果 App Store 之前，将蒲公英 SDK 去掉再提交。
2. 蒲公英 SDK 支持 Xcode 7.0 及以上版本，老的 Xcode 版本可能会编译出错（原因是老的 Xcode 不支持 bitcode）。

注册应用获取 App Key

App Key：唯一标识一个应用的 Key，在蒲公英上的每一个 App 都有一个唯一的 App Key，开发者可以在应用管理页面首页查看。 AppKey

通过Cocoapods添加Framework

pod 'Pgyer'
pod 'PgyUpdate'

手工添加Framewrok

下载蒲公英 SDK (包含应用使用统计，异常上报，用户反馈功能，更新检查)。

1. 添加 PgySDK.framework，PgyUpdate.framework.

将 PgySDK.framework 和 PgyUpdate.framework 拖动到你的 Xcode 工程里，并勾选“Copy items if needed”。

添加framework

2. 配置依赖项

导入 SDK 后，切换到 Build Phases选项卡中，在 Link Binary With Libraries 中添加如下六个系统 framework：

CoreTelephony.framework
OpenGLES.framework
CoreMotion.framework
AudioToolbox.framework
AvFoundation.framework
SystemConfiguration.framework

添加依赖项

如果仅使用检查更新功能，则无需添加依赖项。

初始化并调用 SDK

在项目的AppDelegate.m文件中引入头文件：

#import <PgySDK/PgyManager.h>
#import <PgyUpdate/PgyUpdateManager.h>

在application:didFinishLaunchingWithOptions 中调用 SDK：

//启动基本SDK
[[PgyManager sharedPgyManager] startManagerWithAppId:@"PGY_APP_ID"];
//启动更新检查SDK
[[PgyUpdateManager sharedPgyManager] startManagerWithAppId:@"PGY_APP_ID"];

其中PGY_APP_ID即在蒲公英上获取的App Key。

自动上报 Crash 异常

调用 SDK 后，用户在使用 App 的过程中的崩溃信息将会发送到蒲公英。蒲公英将会统计错误发生的次数，影响的用户，同时开发者还可以在后台查看崩溃的详细信息，包括错误堆栈，机型等，帮助开发者快速定位错误。

蒲公英后台显示的错误是未经过符号化过的，如果需要查看符号化过的堆栈信息，需将代码对应的 dSYM 文件在蒲公英上提交。

注意：在进行本地调试的时候，如果使用 Xcode 启动程序，gdb/lldb 会拦截到信号并停止应用运行，所以调试期间的崩溃信息不会被上传到蒲公英。

手动上报异常

SDK除了可以自动上报导致Crash的异常之外，开发者还可以手动上报Exception。

- (void)reportException
{
    @try {
        NSArray *array = [NSArray arrayWithObjects:@"", nil];
        NSString *value = [array objectAtIndex:10];
    }
    @catch (NSException *exception) {
        [[PgyManager sharedPgyManager] reportException:exception];
    }
}

用户反馈

调用 SDK 后，默认开启用户反馈功能，用户可以通过摇一摇或者三指向上滑动来激活用户反馈功能。

摇一摇

一、关闭用户反馈功能(默认开启)：

[[PgyManager sharedPgyManager] setEnableFeedback:NO];

二、自定义用户反馈激活方式(默认为摇一摇)：

// 设置用户反馈界面激活方式为三指拖动
[[PgyManager sharedPgyManager] setFeedbackActiveType:kPGYFeedbackActiveTypeThreeFingersPan];

// 设置用户反馈界面激活方式为摇一摇
[[PgyManager sharedPgyManager] setFeedbackActiveType:kPGYFeedbackActiveTypeShake];

上述自定义必须在调用 [[PgyManager sharedPgyManager] startManagerWithAppId:@"PGY_APP_ID"] 前设置。

三、自定义用户界面风格

开发者可以通过设置用户反馈界面的颜色主题来改变界面风格，设置之后的颜色会影响到Title的背景颜色和录音按钮的边框颜色，默认为0x37C5A1(绿色)。

[[PgyManager sharedPgyManager] setThemeColor:[UIColor blackColor]];

四、自定义摇一摇灵敏度

开发者可以自定义摇一摇的灵敏度，默认为2.3，数值越小灵敏度越高。

[[PgyManager sharedPgyManager] setShakingThreshold:3.0];

五、除了可以使用“摇一摇”和“三指拖动”来激活用户反馈，开发者还可以通过代码来直接激活用户反馈功能：

[[PgyManager sharedPgyManager] showFeedbackView];

检查更新

蒲公英为开发者提供了检查版本更新的功能，当开启此功能后，开发者如果在蒲公英上提交了新版本，则老的版本中，可以弹出更新提示，来提示用户更新到最新版本。版本更新功能的开启方法如下：

在需要检查更新的文件中引入头文件：

#import <PgyUpdate/PgyUpdateManager.h>

然后调用

[[PgyUpdateManager sharedPgyManager] startManagerWithAppId:@"PGY_APP_ID"];   // 请将 PGY_APP_ID 换成应用的 App Key
[[PgyUpdateManager sharedPgyManager] checkUpdate];

如果有更新版本则会提示用户前往更新，如图所示：

版本更新

如果需要自定义检查更新，则需要调用

[[PgyUpdateManager sharedPgyManager] checkUpdateWithDelegete:self selector:@selector(updateMethod:)];

其中updateMethod为检查更新的回调方法。如果有新版本，则包含新版本信息的字典会被回传，否则字典为nil。如果想更新新版本，可通过调用

[[UIApplication sharedApplication] openURL:[NSURL URLWithString:response[@"downloadURL"]]];

Doc index

Problems encountered, contact us →