67 lines
1.9 KiB
Markdown
67 lines
1.9 KiB
Markdown
# API
|
||
|
||
### downloadRootDir
|
||
|
||
下载的根目录。你可以使用react-native-fs等第三方组件检查其中的内容。
|
||
|
||
### packageVersion
|
||
|
||
当前应用包的版本名。
|
||
|
||
### currentVersion
|
||
|
||
当前版本的Hash号。
|
||
|
||
### isFirstTime
|
||
|
||
是否更新后的首次启动。当此项为真时，你需要在合适的时候调用`markSuccess()`以确保更新成功。否则应用下一次启动时将会回滚。
|
||
|
||
### isRolledBack
|
||
|
||
是否刚刚经历了一次回滚。
|
||
|
||
### async function checkUpdate(appKey)
|
||
|
||
检查更新，返回值有三种情形：
|
||
|
||
1. `{expired: true}`：该应用包(原生部分)已过期，需要前往应用市场下载新的版本。
|
||
```
|
||
{
|
||
expired: true,
|
||
downloadUrl: 'http://appstore/downloadUrl',
|
||
}
|
||
```
|
||
2. `{upToDate: true}`：当前已经更新到最新，无需进行更新。
|
||
|
||
3. `{update: true}`：当前有新版本可以更新。info的`name`、`description`字段可
|
||
以用于提示用户，而`metaInfo`字段则可以根据你的需求自定义其它属性(如是否静默更新、
|
||
是否强制更新等等)。另外还有几个字段，包含了完整更新包或补丁包的下载地址，
|
||
```
|
||
{
|
||
update: true,
|
||
name: '1.0.3-rc',
|
||
hash: 'hash',
|
||
description: '添加聊天功能\n修复商城页面BUG',
|
||
metaInfo: '{"silent":true}',
|
||
updateUrl: 'http://update-packages.reactnative.cn/hash',
|
||
pdiffUrl: 'http://update-packages.reactnative.cn/hash',
|
||
diffUrl: 'http://update-packages.reactnative.cn/hash',
|
||
}
|
||
```
|
||
|
||
### async function downloadUpdate(info)
|
||
|
||
下载更新版本。info为checkUpdate函数的返回值，并且仅当`update:true`时实际进行下载。
|
||
|
||
### function switchVersion(hash)
|
||
|
||
立即重启应用，并加载已经下载完毕的版本。
|
||
|
||
### function switchVersionLater(hash)
|
||
|
||
在下一次启动应用的时候加载已经下载完毕的版本。
|
||
|
||
### function markSuccess()
|
||
|
||
在isFirstTime为true时需在应用成功启动后调用此函数，
|