# WMPFMiniProgramApi.launchMiniProgram

需 WMPF >= 2.1.0 支持,使用前建议阅读注意事项

启动小程序。

# 调用参数

参数 必填 类型 说明 最低版本
params WMPFStartAppParams 启动小程序参数
forceFullscreen boolean 是否强制全屏显示
landscapeMode LandscapeMode 启动小程序展示方式

参数 必填 类型 说明 最低版本
request WMPFStartAppRequest 启动小程序参数(完整版) 2.2.0

# WMPFStartAppParams

属性 必填 类型 说明 最低版本
appId String 小程序 AppId。需在微信硬件平台上和 hostAppId 绑定过
path String 小程序启动页面路径,不填则为小程序首页
appType WMPFAppType 小程序类型,可选择正式版、体验版、开发版

# WMPFAppType

枚举值 说明
APP_TYPE_RELEASE 正式版小程序
APP_TYPE_DEV 开发版小程序,需要登录用户具备小程序开发权限
APP_TYPE_EXP 体验版小程序,需要登录用户具备小程序体验权限

# LandscapeMode

枚举值 说明
NORMAL 默认展示方式,与微信客户端保持一致
LANDSCAPE 适用于强制横屏,且无法转动屏幕的设备(比如车机)
LANDSCAPE_COMPAT 兼容模式,小程序内容将强制 WMPFUiApi.setWindowRatio 设置的比例显示(声明了resizable=true的小程序除外)
FORCE_COMPAT 强制兼容模式(声明了resizable=true的小程序也不例外)

# WMPFStartAppRequest

属性 必填 类型 说明 最低版本
params WMPFStartAppParams 启动小程序参数
forceFullscreen boolean 是否强制全屏显示
landscapeMode LandscapeMode 启动小程序展示方式
displayId int 从 Android DisplayManager 中获取到的 displayId,用于指定小程序显示的屏幕。在某些双屏设备上有用
enterPictureInPicture boolean 进入画中画模式,默认 false。画中画模式需要接入方的 ROM 支持,支持方式参考:https://source.android.google.cn/devices/tech/display/pip?hl=zh-cn

# 返回参数

# 示例代码

val miniProgramApi = WMPF.getInstance().getMiniProgramApi()
miniProgramApi.launchMiniProgram(WMPFStartAppParams(
    appId="wxe5f52902cf4de896",
    path="",
    appType=WMPFAppType.APP_TYPE_RELEASE
))

# 注意

  • WMPF 需要有后台弹出页面权限。
  • 对于体验版和开发版小程序,WMPF 必须要先用户登录之后,且登录的用户具备小程序体验版或者开发版打开权限才能正常打开。
  • 如果弹窗提示 Error Loading WxaAttrs,请确认
    • 可能打开正式版(appType==0),但小程序没有发布过正式版本。小程序正式上线前请根据需要使用 1(开发版)或 2(体验版)。
    • 可能打开开发版(appType==1),但 WMPF 端未扫码登录,或登录用户无开发版权限,或该用户未在工具上上传开发版。
    • 可能打开体验版(appType==2),但 WMPF 端未扫码登录,或登录用户无体验版权限,或小程序当前无体验版。
  • 如果弹窗提示 err:TRANSFER, errCode:-3,一般是当前移动应用无打开对应小程序的权限,请确认