分类： 微信小程序开发

wx.openEmbeddedMiniProgram(Object object)

基础库 2.20.1 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.26.2

微信 鸿蒙 OS 版：支持

功能描述

打开半屏微信小程序。接入指引请参考 半屏微信小程序能力。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
appId string 是 要打开的微信小程序 appId
path string 否 打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在微信小程序的 App.onLaunch、App.onShow 和 Page.onLoad 的回调函数或小游戏的 wx.onShow 回调函数、wx.getLaunchOptionsSync 中可以获取到 query 数据。对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 “?foo=bar”。
extraData object 否 需要传递给目标微信小程序的数据，目标微信小程序可在 App.onLaunch，App.onShow 中获取到这份数据。如果跳转的是小游戏，可以在 wx.onShow、wx.getLaunchOptionsSync 中可以获取到这份数据数据。
envVersion string release 否 要打开的微信小程序版本。仅在当前微信小程序为开发版或体验版时此参数有效。如果当前微信小程序是正式版，则打开的微信小程序必定是正式版。
合法值 说明
develop 开发版
trial 体验版
release 正式版
shortLink string 否 微信小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【微信小程序菜单】->【复制链接】获取。仅 verify=binding 支持。
verify string binding 否 校验方式。 2.24.3
合法值 说明
binding 校验微信小程序管理后台的绑定关系。
unionProduct 校验目标打开链接是否为微信小程序联盟商品。
noRelaunchIfPathUnchanged boolean false 否 不reLaunch目标微信小程序，直接打开目标跳转的微信小程序退后台时的页面，需满足以下条件：1. 目标跳转的微信小程序生命周期未被销毁；2. 且目标当次启动的path、query与上次启动相同，apiCategory以wx.getApiCategory接口的返回结果为准。 2.24.0
allowFullScreen boolean false 否 打开的微信小程序是否支持全屏。基础库 3.10.0 版本起，强制为 true 2.33.0
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

wx.openInquiriesTopic(Object object)

基础库 3.14.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：不支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

功能描述

通过微信小程序打开问一问话题

参数

Object object

属性 类型 默认值 必填 说明
pageId string 是 落地页 id，需在指定页面点击右上角三个点的「复制 ID」按钮获取
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数
Object err
属性 类型 说明
errMsg string 错误信息

示例代码

wx.openInquiriesTopic({
  pageId:'', // 填写落地页 id
  success: res => {

  },
  fail: res => {

  }
})

wx.openOfficialAccountArticle(Object object)

基础库 3.4.8 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：不支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.15.1

微信 鸿蒙 OS 版：支持

功能描述

通过微信小程序打开任意公众号文章（不包括临时链接等异常状态下的公众号文章），必须有点击行为才能调用成功。

参数

Object object

属性 类型 默认值 必填 说明
url string 是 需要打开的公众号地址
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
cancel boolean 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭）
confirm boolean 为 true 时，表示用户点击了确定按钮

object.fail 回调函数

参数
Object err
属性 类型 说明
errMsg string 错误信息
errCode number 错误码

示例代码

  wx.openOfficialAccountArticle({
         url:'', // 此处填写公众号文章连接
         success: res => {
         },
         fail: res => {
         }
     })

wx.openOfficialAccountChat(Object object)

基础库 3.10.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：不支持

微信小程序插件：不支持

功能描述

通过微信小程序打开公众号会话界面

参数

Object object

属性 类型 默认值 必填 说明
username string 是 需要打开的公众号的微信号
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

  wx.openOfficialAccountChat({
         username: '', // 此处填写公众号的微信号
         success: res => {
         },
         fail: res => {
         }
     })

Tips

  1. 跳转的公众号需与微信小程序为同主体或关联主体
  2. 如果用户没有关注则进行回退，跳转到公众号主页

wx.openOfficialAccountProfile(Object object)

基础库 3.7.10 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：不支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.11.2

微信 鸿蒙 OS 版：支持

功能描述

通过微信小程序打开公众号主页

参数

Object object

属性 类型 默认值 必填 说明
username string 是 需要打开的公众号的原始 ID
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

  wx.openOfficialAccountProfile({
         username: '', // 此处填写公众号的原始 ID
         success: res => {
         },
         fail: res => {
         }
     })

Tips

  1. 跳转的公众号需与微信小程序为同主体或关联主体

wx.restartMiniProgram(Object object)

基础库 3.0.1 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：不支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

功能描述

重启当前微信小程序

参数

Object object

属性 类型 默认值 必填 说明
path string 是 打开的页面路径，path 中 ? 后面的部分会成为 query
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

router.addRouteBuilder(string routeType, function routeBuilder)

微信小程序插件：不支持

相关文档: 自定义路由

功能描述

添加自定义路由配置

参数

string routeType

路由类型

function routeBuilder

路由动画定义函数

自定义路由示例

在开发者工具中预览效果

// 定义自定义效果，从右侧推入
const slideRouteBuilder = (customRouteContext) => {
  const { primaryAnimation } = customRouteContext
  const handlePrimaryAnimation = () => {
    'worklet'
    const transX = windowWidth * (1 - primaryAnimation.value)
       return {
           transform: `translateX(${transX}px)`,
       }
  }
  return {
    handlePrimaryAnimation
  }
}

wx.router.addRouteBuilder('slide', slideRouteBuilder)

// 使用自定义路由
wx.navigateTo({
  url: 'xxx',
  routeType: 'slide'
})

wx.router

基础库 2.29.2 开始支持，低版本需做兼容处理。

相关文档: 自定义路由

router 对象，可以通过 wx.router 获取。

方法

router.addRouteBuilder(string routeType, CustomRouteBuilder routeBuilder)

添加自定义路由配置

router.removeRouteBuilder(string routeType)

移除自定义路由配置

router.getRouteContext(Object this)

获取页面对应的自定义路由上下文对象