# uni.getLaunchOptionsSync()

获取首次启动时的参数。返回值与App.onLaunch的回调参数一致

# getLaunchOptionsSync 兼容性

Web Android iOS
4.0 3.91 4.11

# 返回值

类型
OnLaunchOptions
名称 类型 必备 默认值 兼容性 描述
path string -
首次启动时的页面路径。返回值与App.onLaunch的回调参数一致
appScheme string -
首次启动时的Scheme。返回值与App.onLaunch的回调参数一致
appLink string -
首次启动时的appLink。返回值与App.onLaunch的回调参数一致
  • 如果应用通过scheme或applink(通用链接)启动,可以通过本API获取相应参数。配置scheme或applink需在AndroidManifest.xml或info.plist中配置,打包后生效。如开发直达页面功能,一般在应用的onShow生命周期监听。详见

# 示例

hello uni-app x

扫码体验(手机浏览器跳转到App直达页)

Template

Script

<template>
  <page-head title="getLaunchOptionsSync"></page-head>
  <view class="uni-padding-wrap">
    <button @click="getLaunchOptionsSync">getLaunchOptionsSync</button>
    <view class="uni-common-mt">
      <text>应用本次启动路径:</text>
      <text style="margin-top: 5px">{{ launchOptionsPath }}</text>
    </view>
    <view class="uni-common-mt">
      <text>应用本次启动:</text>
      <text style="margin-top: 5px">{{ launchOptionsString }}</text>
    </view>
  </view>
</template>



# 参见

# uni.getEnterOptionsSync()

获取本次启动时的参数。返回值与App.onShow的回调参数一致

uni.getEnterOptionsSync 和 uni.getLaunchOptionsSync 的区别,相当于应用的 onShow 和 onLaunch 的区别,详见应用生命周期

# getEnterOptionsSync 兼容性

Web Android iOS
4.0 4.25 4.25

# 返回值

类型
OnShowOptions
名称 类型 必备 默认值 兼容性 描述
path string -
本次启动时页面的路径
appScheme string -
本次启动时的Scheme。返回值与App.onShow的回调参数一致
appLink string -
本次启动时的appLink。返回值与App.onShow的回调参数一致
  • 如果应用通过scheme或applink(通用链接)启动或从后台激活到前台,可以通过本API获取相应参数。配置scheme或applink需在AndroidManifest.xml或info.plist中配置,打包后生效。如开发直达页面功能,一般在应用的onShow生命周期监听。详见

# 示例

hello uni-app x

扫码体验(手机浏览器跳转到App直达页)

Template

Script

<template>
  <page-head title="getEnterOptionsSync"></page-head>
  <view class="uni-padding-wrap">
    <view class="uni-common-mt">
      <text>应用本次启动路径:</text>
      <text style="margin-top: 5px">{{ enterOptionsString }}</text>
    </view>
  </view>
</template>



# 参见

# 通用类型

# GeneralCallbackResult

名称 类型 必备 默认值 兼容性 描述
errMsg string - - 错误信息