From 7858f2b36eff0c21abf39a8dc55478367658d2bb Mon Sep 17 00:00:00 2001 From: sunnylqm Date: Thu, 8 Feb 2024 23:05:01 +0800 Subject: [PATCH] update --- site/pages/docs/api.md | 68 +++++----------------------------- site/pages/docs/integration.md | 8 +++- 2 files changed, 15 insertions(+), 61 deletions(-) diff --git a/site/pages/docs/api.md b/site/pages/docs/api.md index a94eadb..8391bf4 100644 --- a/site/pages/docs/api.md +++ b/site/pages/docs/api.md @@ -4,43 +4,14 @@ title: API参考 type: 开发指南 --- -### JavaScript 常量 - ---- - -#### downloadRootDir - -下载的根目录。你可以使用`react-native-fs`等第三方组件读取其中的内容。 - ---- - -#### packageVersion - -当前应用原生包的版本。其中 android 取自`versionName`字段(位于`android/app/build.gradle`中)。ios 取自`CFBundleShortVersionString`字段(位于`ios/项目名/Info.plist`中)。 - ---- - -#### currentVersion - -当前热更新版本（jsbundle 文件）的 Hash 号。 - ---- - -#### isFirstTime - -是否更新后的首次启动。当此项为真时，你需要在合适的时候调用`markSuccess()`以确保更新成功。否则应用下一次启动时将会回滚。 - ---- - -#### isRolledBack - -是否刚刚经历了一次回滚。 ### JavaScript 方法 +#### usePushy() + --- -#### async function checkUpdate(appKey) +#### async function checkUpdate() 检查更新，返回值有三种情形： @@ -71,30 +42,15 @@ type: 开发指南 --- -#### async function downloadUpdate(info, callbacks) +#### async function downloadUpdate() -下载更新版本。`info`为`checkUpdate`函数的返回值，并且仅当`update:true`时实际进行下载。 - -从`v5.8.3`版本开始新增接受第二个可选参数，为下载进度的回调函数（`onDownloadProgress`）。可根据回调参数自行设计进度的展示。示例： - -```javascript -const hash = await downloadUpdate( - info, - // 下载回调为可选参数，自v5.8.3版本起可用 - { - onDownloadProgress: ({ received, total }) => { - // 已下载的字节数, 总字节数 - console.log(received, total); - }, - } -); -``` +下载热更包。仅当`update:true`时实际进行下载。会更新`progress`数据。 --- -#### async function downloadAndInstallApk({ url, onDownloadProgress }) +#### function downloadAndInstallApk(url) -下载更新的 apk 包并直接安装。`url`必须为可直接下载到 apk 文件的地址，`onDownloadProgress`为可选的下载进度回调函数，可根据回调参数自行设计进度的展示。自`v5.9.0`版本起可用。 +下载更新的 apk 包并直接安装。`url`必须为可直接下载到 apk 文件的地址。 注意要使用这个功能还需要在`AndroidManifest.xml`中手动添加安装权限，如果需要考虑 Android 7.0 以下的客户，则还需要添加外部存储权限。 @@ -131,24 +87,18 @@ const hash = await downloadUpdate( --- -#### function switchVersion(hash) +#### function switchVersion() 立即重启应用，并加载已经下载完毕的版本。 --- -#### function switchVersionLater(hash) +#### function switchVersionLater() 在下一次启动应用的时候加载已经下载完毕的版本。 --- -#### function simpleUpdate(App: ComponentType, { appKey: string; onPushyEvents?: ({ type: EventType; data: EventData }) => void }) - -极简热更新集成，示例请见[集成文档](/docs/integration#极简快速集成)，其中`onPushyEvents`参数请看下面的方法说明。 - ---- - #### function onPushyEvents(({ type: EventType; data: EventData }) => void) 发生某个事件时的回调，可用于上报统计数据。自`v8.4.0`版本后可用。其中回调参数构型具体如下： diff --git a/site/pages/docs/integration.md b/site/pages/docs/integration.md index 3c107f5..ca27fec 100644 --- a/site/pages/docs/integration.md +++ b/site/pages/docs/integration.md @@ -63,11 +63,14 @@ const pushyClient = new Pushy({ import {Icon, PaperProvider, Snackbar, Banner} from 'react-native-paper'; function App() { const { + client, checkUpdate, downloadUpdate, switchVersionLater, switchVersion, updateInfo, + packageVersion, + currentHash, progress: {received, total} = {}, } = usePushy(); const [showUpdateBanner, setShowUpdateBanner] = useState(false); @@ -100,6 +103,7 @@ function App() { )}