iOS SDK 集成指南

注冊應用獲取 App Key

App Key：唯一標識一個應用的 Key，在蒲公英上的每一個 App 都有一個唯一的 App Key，開發者可以在應用管理頁面首頁查看。

通過Cocoapods添加Framework

pod 'Pgyer'
pod 'PgyUpdate'

手工添加Framewrok

下載蒲公英 SDK (包含應用使用統計，異常上報，用戶反饋功能，更新檢查)。

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

將 PgySDK.framework 和 PgyUpdate.framework 拖動到你的 Xcode 工程里，并勾選“Copy items if needed”。

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"]]];