Install Apk

::: sourceCode

uni.installApk(options) @installapk

GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-installApk

GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-installApk

:::

安装apk

注意：仅支持本地文件路径，网络路径需先通过 uni.downloadFile 下载到本地再调用此 API 安装。

installApk 兼容性

安装Apk最常见的场景是App的升级，更推荐使用uni的App升级中心，这是一个云端一体开源项目，想达到该项目的体验细节需要大量代码，不如直接拿走使用。

参数

options 的属性描述

InstallApkSuccess 的属性值 @installapksuccess-values

InstallApkFail 的属性值 @installapkfail-values

• 1300002 找不到文件 | | errSubject | string | 是 | - | Web: x; 微信小程序: x; Android: -; iOS: x; HarmonyOS: x | 统一错误主题（模块）名称 | | data | any | 否 | - | Web: x; 微信小程序: x; Android: -; iOS: x; HarmonyOS: x | 错误信息中包含的数据 | | cause | Error | 否 | - | Web: x; 微信小程序: x; Android: -; iOS: x; HarmonyOS: x | 源错误信息，可以包含多个错误，详见SourceError | | errMsg | string | 是 | - | Web: x; 微信小程序: x; Android: -; iOS: x; HarmonyOS: x | |

参见

• 相关 Bug

示例

示例为hello uni-app x alpha分支，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例另见

该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验

::: preview

appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/install-apk/install-apk

<template>
  <!-- #ifdef APP -->
  <scroll-view style="flex: 1">
  <!-- #endif -->
    <view>
      <page-head :title="title"></page-head>
      <view class="uni-common-mt">
        <view class="uni-padding-wrap">
          <view class="uni-btn-v">
            <button type="primary" @tap="installApk">
              installApk
            </button>
          </view>
        </view>
      </view>
    </view>
  <!-- #ifdef APP -->
  </scroll-view>
  <!-- #endif -->
</template>
<script setup lang="uts">
  const title = ref('installApk')
  const installApk = () => {
    uni.installApk({
      filePath: "/static/app-android/test.apk",
      complete(res : any) {
        console.log(res);
      }
    })
  }
</script>

:::

Tips

• HBuilderX 3.99以前，uni.install是ext api，需单独下载。从HBuilderX 3.99起 uni-app x 内置了该api，无需再单独下载。

通用类型

GeneralCallbackResult