bl.navigateToMiniProgram
打开另一个小程序
参数说明
Object object
属性 | 类型 | 默认值 | 必填 | 说明 | 版本 |
---|---|---|---|---|---|
appId | string | 是 | 要打开的小程序 appId | ||
vAppId | string | 否 | 虚拟小程序id,如果没有虚拟小程序不用传 | ||
path | string | 否 | 打开的页面路径,如果为空则打开首页。path 中 ? 后面的部分会成为 query,在小程序的 App.onLaunch、App.onShow 和 Page.onLoad 的回调函数或小游戏的 bl.onShow 回调函数、bl.getLaunchOptionsSync 中可以获取到 query 数据。对于小游戏,可以只传入 query 部分,来实现传参效果,如:传入 "?foo=bar"。 | ||
extraData | object | 否 | 需要传递给目标小程序的数据,目标小程序可在 App.onLaunch,App.onShow 中获取到这份数据。如果跳转的是小游戏,可以在 bl.onShow、bl.getLaunchOptionsSync 中可以获取到这份数据数据。 | ||
envVersion | string | 否 | 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版,则打开的小程序必定是正式版。 | ||
success | function | 否 | 接口调用成功的回调函数 | ||
fail | function | 否 | 接口调用失败的回调函数 |
envVersion 的合法值
值 | 说明 | 版本 |
---|---|---|
dev | 开发版 | |
predev | 开发体验版 | |
precheck | 审核体验版 | |
空 | 正式版 |
使用限制
需要用户确认跳转
在跳转至其他小程序前,将统一增加弹窗,询问是否跳转,用户确认后才可以跳转其他小程序。如果用户点击取消,则回调 fail cancel。
每个小程序可跳转的其他小程序数量限制为不超过 10 个
如使用了跳转其他小程序功能,则需要在代码配置中声明将要跳转的小程序名单,限定不超过 10 个,否则将无法通过审核。该名单可在发布新版时更新,不支持动态修改。配置方法详见 小程序全局配置。调用此接口时,所跳转的 appId 必须在配置列表中,否则回调 fail appId "${appId}" is not in navigateToMiniProgramAppIdList。
关于调试
- 在开发者工具上调用此 API 并不会真实的跳转到另外的小程序,但是开发者工具会校验本次调用跳转是否成功。
- 开发者工具上支持被跳转的小程序处理接收参数的调试。
示例代码
bl.navigateToMiniProgram({
appId: ''
path: 'page/index/index?id=123'
extraData: {
foo: 'bar'
}
envVersion: 'dev'
success(res) {
// 打开成功
}
})