首页 > 其他分享 >wx.getLaunchOptionsSync

wx.getLaunchOptionsSync

时间:2024-12-30 09:58:49浏览次数:6  
标签:referrerInfo 场景 getLaunchOptionsSync 微信 App 程序 公众 wx

Object wx.getLaunchOptionsSync()

基础库 2.1.2 开始支持,低版本需做兼容处理

小程序插件:支持,需要小程序基础库版本不低于 2.9.4

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

功能描述

获取小程序启动时的参数。与 App.onLaunch 的回调参数一致。

返回值

Object

启动参数

属性 类型 说明 最低版本
path string 启动小程序的路径 (代码包路径)
scene number 启动小程序的场景值
query Record.<string, string> 启动小程序的 query 参数
shareTicket string shareTicket,详见获取更多转发信息
referrerInfo Object 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 {}。(参见后文注意)
结构属性类型说明appIdstring来源小程序、公众号或 App 的 appIdextraDataObject来源小程序传过来的数据,scene=1037或1038时支持
forwardMaterials Array. 打开的文件信息数组,只有从聊天素材场景打开(scene为1173)才会携带该参数
结构属性类型说明typestring文件的mimetype类型namestring文件名pathstring文件路径(如果是webview则是url)sizenumber文件大小
chatType number 从微信群聊/单聊打开小程序时,chatType 表示具体微信群聊/单聊类型
合法值说明1微信联系人单聊2企业微信联系人单聊3普通微信群聊4企业微信互通群聊
apiCategory string API 类别 2.20.0
合法值说明default默认类别nativeFunctionalized原生功能化,视频号直播商品、商品橱窗等场景打开的小程序browseOnly仅浏览,朋友圈快照页等场景打开的小程序embedded内嵌,通过打开半屏小程序能力打开的小程序

返回有效 referrerInfo 的场景

场景值 场景 appId含义
1020 公众号 profile 页相关小程序列表 来源公众号
1035 公众号自定义菜单 来源公众号
1036 App 分享消息卡片 来源App
1037 小程序打开小程序 来源小程序
1038 从另一个小程序返回 来源小程序
1043 公众号模板消息 来源公众号
1069 移动应用 来源App

不同 apiCategory 场景下的 API 限制

X 表示 API 被限制无法使用;不在表格中的 API 不限制。

default nativeFunctionalized browseOnly embedded
navigateToMiniProgram X X
openSetting X
X X X
X
X
openEmbeddedMiniProgram X X X

注意

部分版本在无referrerInfo的时候会返回 undefined,建议使用 options.referrerInfo && options.referrerInfo.appId 进行判断。

标签:referrerInfo,场景,getLaunchOptionsSync,微信,App,程序,公众,wx
From: https://www.cnblogs.com/AtlasLapetos/p/18627461

相关文章

  • wx.offApiCategoryChange
    wx.offApiCategoryChange(functionlistener)基础库2.33.0开始支持,低版本需做兼容处理。小程序插件:不支持功能描述移除API类别变化事件的监听函数参数functionlisteneronApiCategoryChange传入的监听函数。不传此参数则移除所有监听函数。示例代码constlisten......
  • wx.getEnterOptionsSync
    Objectwx.getEnterOptionsSync()基础库2.9.4开始支持,低版本需做兼容处理。小程序插件:支持,需要小程序基础库版本不低于2.9.4微信Windows版:支持微信Mac版:支持微信鸿蒙OS版:支持功能描述获取本次小程序启动时的参数。如果当前是冷启动,则返回值与App.onLaunch......
  • wx.getApiCategory
    stringwx.getApiCategory()基础库2.33.0开始支持,低版本需做兼容处理。小程序插件:不支持功能描述获取当前API类别返回值stringAPI类别不同apiCategory场景下的API限制X表示API被限制无法使用;不在表格中的API不限制。defaultnativeFunctionalized......
  • wx.postMessageToReferrerPage
    wx.postMessageToReferrerPage(Objectobject)基础库3.7.2开始支持,低版本需做兼容处理。小程序插件:不支持微信鸿蒙OS版:支持功能描述向跳转的源页面发送消息。参数Objectobject属性类型默认值必填说明extraDataObject否需要返回的数据多次调......
  • wx.getDeviceInfo
    Objectwx.getDeviceInfo()基础库2.20.1开始支持,低版本需做兼容处理。小程序插件:支持,需要小程序基础库版本不低于2.21.3微信Windows版:支持微信Mac版:支持微信鸿蒙OS版:支持功能描述获取设备基础信息返回值Object属性类型说明最低版本abistring......
  • wx.getSystemSetting
    Objectwx.getSystemSetting()基础库2.20.1开始支持,低版本需做兼容处理。小程序插件:支持,需要小程序基础库版本不低于2.21.3微信Windows版:支持微信Mac版:支持微信鸿蒙OS版:支持功能描述获取设备设置返回值Object属性类型说明bluetoothEnabledbo......
  • wx.getWindowInfo
    Objectwx.getWindowInfo()基础库2.20.1开始支持,低版本需做兼容处理。小程序插件:支持,需要小程序基础库版本不低于2.21.3微信Windows版:支持微信Mac版:支持微信鸿蒙OS版:支持功能描述获取窗口信息返回值Object属性类型说明pixelRationumber设备......
  • wx.openSystemBluetoothSetting
    wx.openSystemBluetoothSetting(Objectobject)基础库2.20.1开始支持,低版本需做兼容处理。以Promise风格调用:支持需要页面权限:当前是插件页面时,宿主小程序不能调用该接口,反之亦然小程序插件:支持,需要小程序基础库版本不低于2.21.3微信鸿蒙OS版:支持限制:仅在点击行......
  • wx.arrayBufferToBase64
    stringwx.arrayBufferToBase64(ArrayBufferarrayBuffer)从基础库2.4.0开始,本接口停止维护基础库1.1.0开始支持,低版本需做兼容处理。小程序插件:支持微信Windows版:支持微信Mac版:支持微信鸿蒙OS版:支持功能描述将ArrayBuffer对象转成Base64字符串参数A......
  • wx.getSystemInfoSync
    Objectwx.getSystemInfoSync()从基础库2.20.1开始,本接口停止维护,请使用wx.getSystemSetting、wx.getAppAuthorizeSetting、wx.getDeviceInfo、wx.getWindowInfo、wx.getAppBaseInfo代替以Promise风格调用:支持小程序插件:支持,需要小程序基础库版本不低于1.9.6微信Win......