AppUpdateChecker

本仓库包含了 PGYER (蒲公英) 检查更新功能的代码片段，适用 Android App 、 iOS App 和 uni-app。

通过使用相应的代码片段, 可以在目标 App 中快速集成 PGYER (蒲公英) 检查更新功能。

实现细节

通过调用 UpdateChecker 的 check 方法, 间接调用 PGYER (蒲公英) 的后端 API。

具体参照: PGYER API 2.0: 检测 App 是否有更新

使用方式

1. 根据项目类型拷贝 iOS / Android / uni-app 目录下的文件 (目录内只有一个文件) 到项目相应位置。
2. 按照下方代码示例在业务层面需要调用检查更新的地方添加调用代码即可。

• Android 项目调用示例 (Java)

import <code_path>.UpdateChecker;
...
new UpdateChecker("<API_KEY>")
  .check(
    "<APP_KEY>",
    "<(可选)APP版本号>",
    <(可选)(Integer)使用蒲公英生成的自增 Build 版本号>,
    "<(可选)渠道 KEY>",
    new UpdateChecker.Callback() {
      @Override
      public void result(UpdateChecker.UpdateInfo updateInfo) {
      }

      @Override
      public void error(String message) {
      }
    }
  );

Android 代码调用时, 如果无需传递可选参数，用 null 代替即可。

• iOS 项目调用示例 (Swift)

UpdateChecker(_api_key: "<API_KEY>")
  .check(
    appKey: "<APP_KEY>",
    buildVersion: "<(可选)APP版本号>",
    buildBuildVersion: <(可选)(Int)使用蒲公英生成的自增 Build 版本号>,
    channelKey: "<(可选)渠道 KEY>",
    success: { info in
        print(info)
    },
    fail: { error in
        print(error)
    }
  )

• uni-app 项目调用示例 (JS)

import UpdateChecker from '<code_path>/UpdateChecker.js';
...
new UpdateChecker("<API_KEY>")
  .check(
    "<APP_KEY>",
    "<(可选)APP版本号>",
    "<(可选)使用蒲公英生成的自增 Build 版本号>",
    "<(可选)渠道 KEY>",
    updateInfo => {
    },
    error => {
    },
  );

注意事项

1. 代码片段经过详细注释, 大部分 IDE 均可识别并用于类型提示和代码补全。
2. 代码片段中的代码不需要依赖任何第三方内容, 直接复制到项目中即可使用。
3. 使用此代码片段需要网络支持。
4. 对于字段内容存疑可以参照 API 文档 PGYER API 2.0: 检测 App 是否有更新 或者登录 PGYER 后在页面右下角的浮窗里联系技术支持即可。
5. API Key 需要在 PGYER 后台 账户设置 -> API 信息 页面获得。
6. App Key 需要在 PGYER 后台 应用管理 -> 应用 -> 安装设置 页面获得。