蒲公英文档中心

iOS SDK 集成指南

蒲公英 iOS SDK 集成步骤,涵盖 Framework 添加、SDK 初始化、用户反馈与版本更新检查。

蒲公英 SDK 已停止维护,新集成请直接使用 蒲公英 API。本文保留用于已集成项目参考。

本文介绍如何在 iOS 工程中集成蒲公英 SDK,并启用用户反馈与版本更新检查。

前置要求

  • Xcode 7.0 及以上版本(更老版本可能因不支持 bitcode 编译失败)。
  • 在蒲公英已注册的 iOS 应用,并获取 App Key。
  • 若使用 Cocoapods,工程已初始化 Podfile

App Key 可在应用管理页面首页查看:

AppKey

苹果 App Store 禁止含有自动更新功能的 App 上架。蒲公英主 SDK 已移除自动更新功能,但为保证顺利过审,建议在向 App Store 提交之前移除蒲公英 SDK。

添加 Framework

方式一:Cocoapods

pod 'Pgyer'
pod 'PgyUpdate'

方式二:手工添加

下载蒲公英 SDK(含统计、用户反馈与更新检查)。

PgySDK.frameworkPgyUpdate.framework 拖入 Xcode 工程,勾选 Copy items if needed

添加 framework

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
[[PgyManager sharedPgyManager] startManagerWithAppId:@"PGY_APP_ID"];
// 启动更新检查 SDK
[[PgyUpdateManager sharedPgyManager] startManagerWithAppId:@"PGY_APP_ID"];

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

用户反馈

SDK 启动后默认开启用户反馈,支持 "摇一摇" 或 "三指向上滑动" 激活。

摇一摇

可配置项

能力方法
关闭反馈功能setEnableFeedback:NO
激活方式改为三指拖动setFeedbackActiveType:kPGYFeedbackActiveTypeThreeFingersPan
激活方式改为摇一摇(默认)setFeedbackActiveType:kPGYFeedbackActiveTypeShake
自定义主题色(默认 0x37C5A1)setThemeColor:
自定义摇一摇灵敏度(默认 2.3,越小越灵敏)setShakingThreshold:
通过代码激活反馈界面showFeedbackView

上述自定义必须在 startManagerWithAppId: 调用之前完成。

示例:

[[PgyManager sharedPgyManager] setEnableFeedback:NO];
[[PgyManager sharedPgyManager] setFeedbackActiveType:kPGYFeedbackActiveTypeThreeFingersPan];
[[PgyManager sharedPgyManager] setThemeColor:[UIColor blackColor]];
[[PgyManager sharedPgyManager] setShakingThreshold:3.0];
[[PgyManager sharedPgyManager] showFeedbackView];

检查更新

启用后,当您在蒲公英上传新版本时,老版本会弹出更新提示,引导用户更新。

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

#import <PgyUpdate/PgyUpdateManager.h>

调用更新检查:

[[PgyUpdateManager sharedPgyManager] startManagerWithAppId:@"PGY_APP_ID"];   // 替换为应用的 App Key
[[PgyUpdateManager sharedPgyManager] checkUpdate];

有新版本时会提示用户前往更新:

版本更新

自定义更新 UI

使用回调自行处理更新逻辑:

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

updateMethod 为回调方法。有新版本时回传包含版本信息的字典,否则为 nil。跳转到下载页面:

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

本页目录