uni-app x

展示全部

# uni.getAppBaseInfo(options?)

获取app基本信息

# getAppBaseInfo 兼容性

Web	微信小程序	Android	iOS	iOS uni-app x UTS 插件	HarmonyOS
4.0	4.41	3.91	4.11	4.11	4.61

# 参数

名称

类型

必填

默认值

兼容性

描述

options

GetAppBaseInfoOptions

否

包含所有字段的过滤对象

[options=包含所有字段的过滤对象] 过滤的字段对象, 不传参数默认为获取全部字段。

名称	类型	必备	默认值	兼容性	描述
filter	Array<string>	是			过滤字段的字符串数组，假如要获取指定字段，传入此数组。

# 返回值

类型

GetAppBaseInfoResult

名称类型必备默认值兼容性描述

appId

string

否

manifest.json 中应用appid，即DCloud appid。

appName

string

否

manifest.json 中应用名称。

appVersion

string

否

manifest.json 中应用版本名称，如果离线打包注意修改修改index.kt中UniAppConfig类型中的版本名称文档。

appVersionCode

string

否

manifest.json 中应用版本号，如果离线打包注意修改修改index.kt中UniAppConfig类型中的版本号文档。

appLanguage

string

否

应用设置的语言en、zh-Hans、zh-Hant、fr、es

language

string

否

应用设置的语言

appWgtVersion

string

否

应用资源（wgt）的版本名称。

hostLanguage

string

否

小程序宿主语言

hostVersion

string

否

App、小程序宿主版本。

hostName

string

否

小程序宿主名称

hostPackageName

string

否

小程序宿主包名

hostSDKVersion

string

否

uni小程序SDK版本、小程序客户端基础库版本

hostTheme

string

否

系统当前主题，取值为light或dark。微信小程序全局配置"darkmode":true时才能获取，否则为 null （不支持小游戏）

isUniAppX

boolean

否

是否uni-app x

uniCompilerVersion

string

否

uni 编译器版本

uniPlatform

string

否

uni-app 运行平台。

合法值	描述
app
web
mp-weixin
mp-alipay
mp-baidu
mp-toutiao
mp-lark
mp-qq
mp-kuaishou
mp-jd
mp-360
quickapp-webview
quickapp-webview-union
quickapp-webview-huawei

uniRuntimeVersion

string

否

uni 运行时版本

uniCompilerVersionCode

number

否

uni 编译器版本号

uniRuntimeVersionCode

number

否

uni 运行时版本号

packageName

string

否

Android的包名

bundleName

string

否

鸿蒙的包名

bundleId

string

否

iOS的bundleId

signature

string

否

Android: 应用签名证书的SHA1值（全部为小写，中间不包含“:”）。
iOS: 应用签名证书中绑定的Bundle ID（AppleID）的md5值（全部为小写）。

appTheme

string

否

当前App的主题

合法值	描述
light
dark
auto

channel

string

否

当前应用分发的渠道

SDKVersion

string

否

客户端基础库版本

enableDebug

boolean

否

fontSizeScaleFactor

number

否

微信字体大小缩放比例

fontSizeSetting

number

否

需要基础库： 2.23.4

微信字体大小，单位px

host

GetAppBaseInfoResultHost

否

当前小程序运行的宿主环境

名称	类型	必备	默认值	兼容性	描述
appId	string	否			宿主 app（第三方App）对应的 appId （当小程序运行在第三方App环境时才返回）

theme

string

否

系统当前主题，取值为light或dark，全局配置"darkmode":true时才能获取，否则为 undefined （不支持小游戏）

可选值：
- 'dark': 深色主题;
- 'light': 浅色主题;

合法值	描述
dark
light

~~version~~

string

否

引擎版本号。已废弃，仅为了向下兼容保留 已废弃，仅为了向下兼容保留

~~uniCompileVersion~~

string

否

uni 编译器版本 已废弃，仅为了向下兼容保留

~~uniCompileVersionCode~~

number

否

uni 编译器版本号 已废弃，仅为了向下兼容保留

# appTheme

获取应用的主题配置信息，仅app平台支持。 appTheme返回值为auto，代表跟随系统。此时需通过getSystemInfo或getDeviceInfo查询osTheme获取当前到底是light还是dark。

# hostTheme

在浏览器中，hostTheme可能是os的Theme而不是浏览器的外观。这取决于浏览器的实现。

# channel

获取应用的渠道信息，仅app-android平台支持渠道包。

云打包时需在“App打包”界面中配置，详情参考配置渠道包。
离线打包时需在原生工程中配置，详情参考Android平台配置应用渠道包

# 示例

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

示例

<template>
  <page-head :title="title"></page-head>
  <view class="uni-common-mt">
    <view class="uni-list">
      <view class="uni-list-cell" v-for="(item, index) in data.items" :key="index" style="align-items: center;">
        <view class="uni-pd">
          <view class="uni-label" style="width:180px;">{{item.label}}</view>
        </view>
        <view class="uni-list-cell-db">
          <text class="uni-list-cell-db-text">{{ item.value == '' ? '未获取' : item.value }}</text>
        </view>
      </view>
    </view>
    <view class="uni-padding-wrap">
      <view class="uni-btn-v">
        <button type="primary" @tap="getAppBaseInfo">获取App基础信息</button>
      </view>
    </view>
  </view>
</template>
<script setup lang="uts">
  type Item = {
    label : string,
    value : string,
  }

  type DataType = {
    items: Item[];
  }

  const title = ref('getAppBaseInfo')
  const data = reactive({
    items: [] as Item[],
  } as DataType)

  const getAppBaseInfo = () => {
    const res = uni.getAppBaseInfo();
    const res_str = JSON.stringify(res);
    const res_obj = JSON.parseObject(res_str);
    const res_map = res_obj!.toMap();
    let keys = [] as string[]
    res_map.forEach((_, key) => {
      keys.push(key);
    });

    data.items = [] as Item[];
    keys.sort().forEach(key => {
      const value = res[key];
      if (value != null) {
        const item = {
          label: key,
          value: "" + ((typeof value == "object") ? JSON.stringify(value) : value)
        } as Item;
        data.items.push(item);
      }
    });
  }

</script>

<style>
  .uni-pd {
    padding-left: 15px;
  }
</style>

示例源码如下，请查看 pre > code 标签中的内容

<template>
  <page-head :title="title"></page-head>
  <view class="uni-common-mt">
    <view class="uni-list">
      <view class="uni-list-cell" v-for="(item, index) in data.items" :key="index" style="align-items: center;">
        <view class="uni-pd">
          <view class="uni-label" style="width:180px;">{{item.label}}</view>
        </view>
        <view class="uni-list-cell-db">
          <text class="uni-list-cell-db-text">{{ item.value == '' ? '未获取' : item.value }}</text>
        </view>
      </view>
    </view>
    <view class="uni-padding-wrap">
      <view class="uni-btn-v">
        <button type="primary" @tap="getAppBaseInfo">获取App基础信息</button>
      </view>
    </view>
  </view>
</template>
<script setup lang="uts">
  type Item = {
    label : string,
    value : string,
  }

  type DataType = {
    items: Item[];
  }

  const title = ref('getAppBaseInfo')
  const data = reactive({
    items: [] as Item[],
  } as DataType)

  const getAppBaseInfo = () => {
    const res = uni.getAppBaseInfo();
    const res_str = JSON.stringify(res);
    const res_obj = JSON.parseObject(res_str);
    const res_map = res_obj!.toMap();
    let keys = [] as string[]
    res_map.forEach((_, key) => {
      keys.push(key);
    });

    data.items = [] as Item[];
    keys.sort().forEach(key => {
      const value = res[key];
      if (value != null) {
        const item = {
          label: key,
          value: "" + ((typeof value == "object") ? JSON.stringify(value) : value)
        } as Item;
        data.items.push(item);
      }
    });
  }

</script>

<style>
  .uni-pd {
    padding-left: 15px;
  }
</style>