From 2a6efa074f3b398c445741180cd5cff9192c56da Mon Sep 17 00:00:00 2001 From: DCloud_LXH <283700113@qq.com> Date: Fri, 29 Apr 2022 15:41:31 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20getLaunchOptionsSync=E3=80=81getEnterOp?= =?UTF-8?q?tionsSync?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/_sidebar.md | 4 +++- docs/api/plugins/getEnterOptionsSync.md | 28 ++++++++++++++++++++++ docs/api/plugins/getLaunchOptionsSync.md | 30 ++++++++++++++++++++++++ 3 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 docs/api/plugins/getEnterOptionsSync.md create mode 100644 docs/api/plugins/getLaunchOptionsSync.md diff --git a/docs/api/_sidebar.md b/docs/api/_sidebar.md index 33bfe0a13..4f67e841a 100644 --- a/docs/api/_sidebar.md +++ b/docs/api/_sidebar.md @@ -4,7 +4,9 @@ * [定时器](api/timer.md) * [uni.base64ToArrayBuffer](api/base64ToArrayBuffer.md) * [uni.arrayBufferToBase64](api/arrayBufferToBase64.md) - * [生命周期](api/lifecycle.md) + * 生命周期 + * [uni.getLaunchOptionsSync](api/plugins/getLaunchOptionsSync.md) + * [uni.getEnterOptionsSync](api/plugins/getEnterOptionsSync.md) * [应用级事件](api/application.md) * [拦截器](api/interceptor.md) * [全局API](api/global.md) diff --git a/docs/api/plugins/getEnterOptionsSync.md b/docs/api/plugins/getEnterOptionsSync.md new file mode 100644 index 000000000..66b45193f --- /dev/null +++ b/docs/api/plugins/getEnterOptionsSync.md @@ -0,0 +1,28 @@ +### uni.getEnterOptionsSync() + +获取本次启动时的参数。如果当前是冷启动，则返回值与 App.onLaunch 的回调参数一致 + +|App|H5|微信小程序|支付宝小程序|字节跳动小程序|快手小程序|QQ小程序|百度小程序|京东小程序|钉钉小程序|飞书小程序| +|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-| +|√ `(3.4.9+)`|x|√|√|√|√|x|x|x|x|x| + +**返回参数说明** + +|参数名|类型|说明|平台差异说明| +|:-|:-|:-|:-| +|path|String|启动的路径(代码包路径)|其他平台均支持，`字节小程序(1.12.0)`| +|scene|Number|启动时的场景值，具体值含义请查看各平台文档说明|其他平台均支持，`字节小程序(1.12.0)`| +|query|Object|启动时的 query 参数|其他平台均支持，`字节小程序(1.12.0)`| +|referrerInfo|Object|来源信息。如果没有则返回 `{}`|其他平台均支持，`字节小程序(1.15.0)`| +|forwardMaterials|Array.|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`微信小程序`| +|chatType|number|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`仅微信小程序`| +|apiCategory|string|API 类别|`仅微信小程序(2.20.0)`| +|showFrom|number|唤起小程序的方式，目前取值固定为 10，表示通过 schema 唤起|`仅字节小程序(1.90.0)`| +|mode|'default' | 'halfPage'|启动小程序的模式|`仅快手小程序`| + +**Object referrerInfo** + +|属性|类型|说明|平台差异说明| +|:-|:-|:-|:-| +|appId|String|来源小程序 appId |其他平台均支持，`字节小程序(1.15.0)`| +|extraData|Object|来源小程序传过来的数据。|其他平台均支持，`字节小程序(1.15.0)`| \ No newline at end of file diff --git a/docs/api/plugins/getLaunchOptionsSync.md b/docs/api/plugins/getLaunchOptionsSync.md new file mode 100644 index 000000000..8163fe3c1 --- /dev/null +++ b/docs/api/plugins/getLaunchOptionsSync.md @@ -0,0 +1,30 @@ +### uni.getLaunchOptionsSync() + +获取本次启动时的参数。如果当前是冷启动，则返回值与App.onLaunch的回调参数一致 + +|App|H5|微信小程序|支付宝小程序|字节跳动小程序|QQ小程序|快手小程序|钉钉小程序|飞书小程序|百度小程序|京东小程序| +|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-| +|√ `(3.4.9+)`|x|√|√|√|√|√|√|√|x|x| + +**返回参数说明** + +|参数名|类型|说明|平台差异说明| +|:-|:-|:-|:-| +|path|String|启动的路径(代码包路径)|其他平台均支持，`字节小程序(1.12.0)`| +|scene|Number|启动时的场景值，具体值含义请查看各平台文档说明。钉钉小程序在 IDE 恒为0000，真机不支持。|其他平台均支持，`字节小程序(1.12.0)`| +|query|Object|启动时的 query 参数|其他平台均支持，`字节小程序(1.12.0)`| +|referrerInfo|Object|来源信息。如果没有则返回 `{}`|其他平台均支持，`字节小程序(1.15.0)`，`飞书小程序不支持`，`钉钉小程序不支持`| +|forwardMaterials|Array.|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`微信小程序`、`QQ小程序`| +|entryDataHash|string|群入口信息，通过群应用商店打开、群分享卡片打开的小程序可获得|`仅QQ小程序`| +|chatType|number|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`仅微信小程序`| +|apiCategory|string|API 类别|`仅微信小程序(2.20.0)`| +|showFrom|number|唤起小程序的方式，目前取值固定为 10，表示通过 schema 唤起|`仅字节小程序(1.90.0)`| +|mode|'default' | 'halfPage'|启动小程序的模式|`仅快手小程序`| +|subScene|string|子场景值(定义待补充)|`仅飞书小程序`| + +**Object referrerInfo** + +|属性|类型|说明|平台差异说明| +|:-|:-|:-|:-| +|appId|String|来源小程序 appId |其他平台均支持，`字节小程序(1.15.0)`| +|extraData|Object|来源小程序传过来的数据。|其他平台均支持，`字节小程序(1.15.0)`| \ No newline at end of file -- GitLab