diff --git a/README.md b/README.md index 25f6e179bc52c04fac60e378a6d05618b0859a3f..0d05a86bd6d5a2911f8da3f7b1f7d6fb983a22f7 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ # uni-app的特点 -- 开发者和案例更多：HBuilder装机量380万台，开发者社区月活百万，70多个QQ微信群承载10万人。案例众多，uni统计月活2亿+（[详见](https://uniapp.dcloud.io/case)） +- 开发者和案例更多：HBuilder装机量420万台，开发者社区月活百万，70多个QQ微信群承载10万人。案例众多，uni统计月活4.5亿（[详见](https://uniapp.dcloud.io/case)） - 性能更高（见[评测](https://juejin.im/post/5ca1736af265da30ae314248)） - 更丰富的周边生态，[插件市场](https://ext.dcloud.net.cn/)数千款插件 - 提供比小程序原生开发更好的开发体验、更高的工程化效率 @@ -48,7 +48,9 @@ ## 插件市场 -`uni-app`有丰富的插件生态，众多开发者提交了各种组件、sdk、项目模板，详见：[https://ext.dcloud.net.cn/](https://ext.dcloud.net.cn/) +`uni-app`有丰富的插件生态，众多开发者提交了数千款组件、sdk、项目模板，详见：[https://ext.dcloud.net.cn/](https://ext.dcloud.net.cn/) + +除了众多三方ui库，官方还提供了uni-ui，在性能和跨端兼容方面有更强的优势。详见：[https://ext.dcloud.net.cn/plugin?id=55](https://ext.dcloud.net.cn/plugin?id=55) ## 现有项目如何迁移到uni-app体系 @@ -71,7 +73,7 @@ - 答：不是。大量开发者用uni-app只做一个端，详见[案例](https://uniapp.dcloud.io/case)。对于开发者而言，一个优秀工具在手，做什么都不愁。 - 问：uni-app以后会不会变更开源协议，转向收费？ -- 答：官方承诺永远不会变更开源协议。无论HBuilderX、uni-app、5+app，面向中国人永久免费。 +- 答：官方承诺永远不会变更开源协议。无论HBuilderX、uni-app、App，面向中国人永久免费。 ## 更多资料 diff --git a/docs/README.md b/docs/README.md index 3c12b2e4c93b56ac28d297165eead09e377c80f4..355ed9198780823add1b130b1afb616b429daa60 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,7 @@ ```uni-app``` 是一个使用 [Vue.js](https://vuejs.org/) 开发所有前端应用的框架，开发者编写一套代码，可发布到iOS、Android、H5、以及各种小程序（微信/支付宝/百度/头条/QQ/钉钉）等多个平台。 -`DCloud`公司拥有380万开发者，几十万应用案例、8.5亿手机端用户，数千款uni-app插件、70+微信/qq群。阿里小程序工具官方内置uni-app（[详见](https://docs.alipay.com/mini/ide/0.70-stable)），腾讯课堂官方为uni-app录制培训课程（[详见](https://ask.dcloud.net.cn/article/35640)），开发者可以放心选择。 +`DCloud`公司拥有420万开发者，几十万应用案例、10.5亿手机端用户，数千款uni-app插件、70+微信/qq群。阿里小程序工具官方内置uni-app（[详见](https://docs.alipay.com/mini/ide/0.70-stable)），腾讯课堂官方为uni-app录制培训课程（[详见](https://ask.dcloud.net.cn/article/35640)），开发者可以放心选择。 `uni-app`在手，做啥都不愁。即使不跨端，```uni-app```也是更好的小程序开发框架（[详见](https://ask.dcloud.net.cn/article/35947)）、更好的App跨平台框架、更方便的H5开发框架。不管领导安排什么样的项目，你都可以快速交付，不需要转换开发思维、不需要更改开发习惯。 @@ -74,7 +74,7 @@
开发者/案例数量更多
-

10万+案例、uni统计月活过2亿、70+微信/qq群、更高的百度指数

+

10万+案例、uni统计月活过3亿、70+微信/qq群、更高的百度指数

跨端完善度更高，真正落地的提高生产力

@@ -96,7 +96,7 @@
性能体验优秀

体验更好的Hybrid框架，加载新页面速度更快。

App端支持weex原生渲染，可支撑更流畅的用户体验。

-

小程序端的性能优于市场其他框架。评测

+

小程序端的性能优于市场其他框架。评测

@@ -105,7 +105,7 @@
周边生态丰富
-

插件市场数千款插件。

+

插件市场数千款插件。

支持NPM、支持小程序组件和SDK、兼容mpvue组件和项目、兼容weex组件。

微信生态的各种sdk可直接用于跨平台App。

@@ -150,14 +150,14 @@ 从下面```uni-app```功能框架图可看出，```uni-app```在跨平台的过程中，不牺牲平台特色，可优雅的调用平台专有能力，真正做到海纳百川、各取所长。 -![](https://dcloud-img.oss-cn-hangzhou.aliyuncs.com/uni-app/doc/uni0124.png) +![](https://img.cdn.aliyun.dcloud.net.cn/uni-app/doc/uni0124.png) ### 一套代码，运行到多个平台 ```uni-app```实现了一套代码，同时运行到多个平台；如下图所示，一套代码，同时运行到iOS模拟器、Android模拟器、H5、微信开发者工具、支付宝小程序Studio、百度开发者工具、字节跳动开发者工具、QQ开发者工具（底部8个终端选项卡代表8个终端模拟器）： -![](https://dcloud-img.oss-cn-hangzhou.aliyuncs.com/uni-app/doc/dev1x8.jpg) +![](https://img.cdn.aliyun.dcloud.net.cn/uni-app/doc/dev1x8.jpg) 实际运行效果如下（点击图片可放大）： -![](https://dcloud-img.oss-cn-hangzhou.aliyuncs.com/uni-app/doc/run1x9.jpg) +![](https://img.cdn.aliyun.dcloud.net.cn/uni-app/doc/run1x9.jpg) diff --git a/docs/_navbar.md b/docs/_navbar.md index eb7cbc78d026107541767c5573f7d8cd52850ba5..a003126d635aa495a347cb6c681e44ef8b85cbde 100644 --- a/docs/_navbar.md +++ b/docs/_navbar.md @@ -2,6 +2,7 @@ * [框架](collocation/pages.md) * [组件](component/README.md) * [API](api/README.md) +* [uniCloud](uniCloud/README.md) * [其它规范](javascript:;) - [App扩展规范HTML5 Plus](http://www.html5plus.org/doc/h5p.html) - [微信小程序](https://developers.weixin.qq.com/miniprogram/dev/framework/) @@ -21,4 +22,4 @@ - \ No newline at end of file + diff --git a/docs/_sidebar.md b/docs/_sidebar.md index fb907ae458828628429e353334d737feb6bbf135..c9027c19e2122eaead9c81ae5336086e931d9867 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -11,10 +11,12 @@ * [高效开发技巧](snippet.md) * [性能优化建议](performance.md) * [开放生态](ecosystem.md) +* [从其他项目转uni-app](translate.md) +* [混合开发](hybrid.md) +* [uni小程序sdk](https://ask.dcloud.net.cn/docs/#https://ask.dcloud.net.cn/article/36941) * [运营服务](cloud.md) * [案例](case.md) * [开源项目资源汇总](casecode.md) -* [从其他项目转uni-app](translate.md) * [选型评估指南](select.md) * [常见问题](faq.md) * [更新日志](release.md) @@ -38,48 +40,48 @@ -
- -
-
官方QQ交流群
-
群26：147867597  点此加入
-
群35：713420817（2000人已满）
-
群34：530305531（2000人已满）
-
群33：498071674（2000人已满）
-
群32：166188631（500人已满）
-
群31：567471669（500人已满）
-
群30：371046920（500人已满）
-
群29：202965481（500人已满）
-
群28：166188776（2000人已满
-
群27：811363410（2000人已满
- -
群25：165297000（500人已满）
-
群24：672494800（500人已满）
-
群23：599958679（500人已满）
-
群22：687186952（1000人已满）
-
群21：717019120（2000人已满）
-
群20：165796402（500人已满）
-
群19：165657124（1000人已满）
-
群18：698592271（500人已满）
-
群17：951348804（1000人已满）
-
群16：719211033（1000人已满）
-
群15：516984120（500人已满）
-
群14：465953250（500人已满）
-
群13：699478442（500人已满）
-
群12：884860657（500人已满）
-
群11：296811328（1000人已满）
-
群10：959059626（2000人已满）
-
群9：775128777（500人已满）
-
群8：695442854（500人已满）
-
群7：942061423（500人已满）
-
群6：697264024（2000人已满）
-
群5：731951419（500人已满）
-
群4：942702595（1000人已满）
-
群3：773794803（1000人已满）
-
群2：901474938（1000人已满）
-
群1：531031261（1000人已满）
-
-
+
+ +
+
官方QQ交流群
+
群11：296811328  点此加入
+
群35：713420817（2000人已满）
+
群34：530305531（2000人已满）
+
群33：498071674（2000人已满）
+
群32：166188631（2000人已满）
+
群31：567471669（2000人已满）
+
群30：371046920（2000人已满）
+
群29：202965481（1000人已满）
+
群28：166188776（2000人已满）
+
群27：811363410（2000人已满）
+
群26：147867597（2000人已满）
+
群25：165297000（2000人已满）
+
群24：672494800（2000人已满）
+
群23：599958679（2000人已满）
+
群22：687186952（1000人已满）
+
群21：717019120（2000人已满）
+
群20：165796402（2000人已满）
+
群19：165657124（1000人已满）
+
群18：698592271（1000人已满）
+
群17：951348804（1000人已满）
+
群16：719211033（2000人已满）
+
群15：516984120（2000人已满）
+
群14：465953250（2000人已满）
+
群13：699478442（2000人已满）
+
群12：884860657（2000人已满）
+ +
群10：959059626（2000人已满）
+
群9：775128777（2000人已满）
+
群8：695442854（2000人已满）
+
群7：942061423（2000人已满）
+
群6：697264024（2000人已满）
+
群5：731951419（1000人已满）
+
群4：942702595（1000人已满）
+
群3：773794803（1000人已满）
+
群2：901474938（1000人已满）
+
群1：531031261（1000人已满）
+
+
diff --git a/docs/api/_sidebar.md b/docs/api/_sidebar.md index 0b9b33610c7784b323fd9c995c7b314ba8b023d4..f5df915eaf5e77d0988cd6d4bae00d0b4e1eefdf 100644 --- a/docs/api/_sidebar.md +++ b/docs/api/_sidebar.md @@ -103,6 +103,8 @@ * [uni.canvasGetImageData](api/canvas/canvasGetImageData.md) * [CanvasContext](api/canvas/CanvasContext.md) * [CanvasGradient](api/canvas/CanvasGradient.md) +* 广告 + * [激励视频广告](api/ad/rewarded-video-ad.md) * 第三方服务 * [获取服务供应商](api/plugins/provider.md) * [登录](api/plugins/login.md) @@ -123,10 +125,12 @@ * [统计](api/other/report.md) * [卡券](api/other/card.md) * [模板消息](api/other/template.md) + * [订阅消息](api/other/requestSubscribeMessage.md) * [小程序更新](api/other/update.md) * [调试](api/other/set-enable-debug.md) * [获取第三方平台数据](api/other/get-extconfig.md) * [广告](api/other/advertisement.md) +
  • diff --git a/docs/api/ad/rewarded-video-ad.md b/docs/api/ad/rewarded-video-ad.md new file mode 100644 index 0000000000000000000000000000000000000000..b1eb1c5df2b1dc0c7999ce09d703328cbaa5a413 --- /dev/null +++ b/docs/api/ad/rewarded-video-ad.md @@ -0,0 +1,155 @@ +### 激励视频广告 + +- app端的广告源由腾讯广点通、头条穿山甲广告联盟提供，DCloud负责聚合 +- 小程序端的广告由小程序平台提供 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√（2.5.11+）|x|√|x|x|x|x| + +**开通配置广告** + +开通广告步骤： +1. 开通广告 +需在广告平台后台操作： + * App平台：[https://uniad.dcloud.net.cn/](https://uniad.dcloud.net.cn/) + * 小程序平台：在各自的小程序管理后台操作。 +2. 申请广告位id +在各位后台申请广告位id +3. App端打包后生效，打包时必须选择要集成的广告SDK（穿山甲、广点通）。 + + +激励视频广告组件是由客户端原生的图片、文本、视频控件组成的，层级最高，会覆盖在普通组件上。 + +### 广告创建 + +开发者可以调用 uni.createRewardedVideoAd 创建激励视频广告组件。该方法返回的是一个单例，该实例仅对当前页面有效，不允许跨页面使用。 + +激励视频广告组件默认是隐藏的，因此可以提前创建，以提前初始化组件。开发者可以在页面的 `onReady` 事件回调中创建广告实例，并在该页面的生命周期内重复调用该广告实例。 + +``` + +``` + +为避免滥用广告资源，目前每个用户每天可观看激励式视频广告的次数有限，建议展示广告按钮前先判断广告是否拉取成功。 + +### 显示/隐藏 +激励视频广告组件默认是隐藏的，在用户主动触发广告后，开发者需要调用 RewardedVideoAd.show() 进行显示。 + +``` +rewardedVideoAd.show() +``` + +只有在用户点击激励视频广告组件上的 关闭广告 按钮时，广告才会关闭。开发者不可控制激励视频广告组件的隐藏。 + +### 广告拉取成功与失败 + +激励视频广告组件是自动拉取广告并进行更新的。在组件创建后会拉取一次广告，用户点击 关闭广告 后会去拉取下一条广告。 + +如果拉取成功，通过 `RewardedVideoAd.onLoad()` 注册的回调函数会执行，`RewardedVideoAd.show()` 返回的 Promise 也会是一个 resolved Promise。两者的回调函数中都没有参数传递。 + +``` +rewardedVideoAd.onLoad(() => { + console.log('激励视频 广告加载成功') +}) + +rewardedVideoAd.show() +.then(() => console.log('激励视频 广告显示')) +``` + +如果拉取失败，通过 `RewardedVideoAd.onError()` 注册的回调函数会执行，回调函数的参数是一个包含错误信息的对象。常见异常错误参考文档 + +``` +rewardedVideoAd.onError(err => { + console.log(err) +}) +``` + +`RewardedVideoAd.show()` 返回的 Promise 也会是一个 rejected Promise。 + +``` +rewardedVideoAd.show() +.catch(err => console.log(err)) +``` + +### 拉取失败，重新拉取 + +如果组件的某次自动拉取失败，那么之后调用的 show() 将会被 reject。此时可以调用 `RewardedVideoAd.load()` 手动重新拉取广告。 + +``` +rewardedVideoAd.show() +.catch(() => { + rewardedVideoAd.load() + .then(() => rewardedVideoAd.show()) + .catch(err => { + console.log('激励视频 广告显示失败') + }) +}) +``` + +如果组件的自动拉取是成功的，那么调用 `load()` 方法会直接返回一个 resolved Promise，而不会去拉取广告。 + +``` +rewardedVideoAd.load() +.then(() => rewardedVideoAd.show()) +``` + +### 监听用户关闭广告 + +只有在用户点击激励视频广告组件上的 关闭广告 按钮时，广告才会关闭。这个事件可以通过 `RewardedVideoAd.onClose()` 监听。 + +`RewardedVideoAd.onClose()` 的回调函数会传入一个参数 res，res.isEnded 描述广告被关闭时的状态。 + + +|属性|类型|说明| +|:-:|:-:|:-:| +|isEnded|boolean|视频是否是在用户完整观看的情况下被关闭的，true 表示用户是在视频播放完以后关闭的视频，false 表示用户在视频播放过程中关闭了视频 + + +开发者需要根据 res.isEnded 判断是否视频是否播放结束、可以向用户下发奖励。 + +``` +rewardedVideoAd.onClose(res => { + // 用户点击了【关闭广告】按钮 + if (res && res.isEnded) { + // 正常播放结束 + } else { + // 播放中途退出 + } +}) +``` + +**注意事项** + +多次调用 `RewardedVideoAd.onLoad()`、`RewardedVideoAd.onError()`、`RewardedVideoAd.onClose()` 等方法监听广告事件会产生多次事件回调，建议在创建广告后监听一次即可，或者先取消原有的监听事件再重新监听。 + + +**AD组件** +文档地址：[https://uniapp.dcloud.io/component/ad](https://uniapp.dcloud.io/component/ad) diff --git a/docs/api/canvas/CanvasContext.md b/docs/api/canvas/CanvasContext.md index b5dac710281aa7f67959f03b9ed13b00e6a31671..7223a0eb5f1260834dec530b122ceb93596587a3 100644 --- a/docs/api/canvas/CanvasContext.md +++ b/docs/api/canvas/CanvasContext.md @@ -65,7 +65,7 @@ App-nvue下如需使用canvas，暂未封装为uni API，可参考[文档](https 在绘制新形状时应用的合成操作的类型。目前安卓版本只适用于 `fill` 填充块的合成，用于 `stroke` 线段的合成效果都是 `source-over`。 目前支持的操作有 -* 5+App和H5端：source-over、destination-over、source-in、destination-in、source-out、destination-out、source-atop、destination-atop、lighter、darker、xor、copy +* App和H5端：source-over、destination-over、source-in、destination-in、source-out、destination-out、source-atop、destination-atop、lighter、darker、xor、copy * 微信小程序安卓端：xor, source-over, source-atop, destination-out, lighter, overlay, darken, lighten, hard-light * 微信小程序iOS端：xor, source-over, source-atop, destination-over, destination-out, lighter, multiply, overlay, darken, lighten, color-dodge, color-burn, hard-light, soft-light, difference, exclusion, saturation, luminosity @@ -73,7 +73,7 @@ App-nvue下如需使用canvas，暂未封装为uni API，可参考[文档](https **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| |√|√|√|√|√|√| diff --git a/docs/api/canvas/canvasToTempFilePath.md b/docs/api/canvas/canvasToTempFilePath.md index 4c4d9be9e29089af16d70924505ba2cf4aba286b..283de0d395523a3bb47f35f9311793052df8bb7d 100644 --- a/docs/api/canvas/canvasToTempFilePath.md +++ b/docs/api/canvas/canvasToTempFilePath.md @@ -1,8 +1,14 @@ -#### uni.canvasToTempFilePath(OBJECT, this) +#### uni.canvasToTempFilePath(object, component) -把当前画布指定区域的内容导出生成指定大小的图片，并返回文件路径。在自定义组件下，第二个参数传入自定义组件实例 this，以操作组件内 `` 组件。 +把当前画布指定区域的内容导出生成指定大小的图片，并返回文件路径。在自定义组件下，第二个参数传入自定义组件实例，以操作组件内 `` 组件。 -**OBJECT参数说明：** +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|x（[CanvasContext.toTempFilePath](https://opendocs.alipay.com/mini/api/rod3ti)）|√|√|√| + +**object参数说明：** |参数 |类型 |必填 |说明 | |---|---|---|---|---| @@ -30,9 +36,13 @@ uni.canvasToTempFilePath({ destWidth: 100, destHeight: 100, canvasId: 'myCanvas', - success: function(res) { - // 在H5平台下，tempFilePath 为 base64 + success: function(res) { + // 在H5平台下，tempFilePath 为 base64 console.log(res.tempFilePath) } }) ``` + +**Tips** + +- H5端 Canvas 内绘制的图像需要支持跨域访问才能成功。 \ No newline at end of file diff --git a/docs/api/extend/native-plugin.md b/docs/api/extend/native-plugin.md index fd2cdeacaf9c29aa352c84a703d161f03f92799c..de121bd9c87e74b4c8c582e0271ba0064079204d 100644 --- a/docs/api/extend/native-plugin.md +++ b/docs/api/extend/native-plugin.md @@ -4,7 +4,7 @@ 平台差异说明： -* 5+App +* App 自 HXuilderX1.4 版本起，``uni-app`` 支持引入原生插件，使用方式如下： diff --git a/docs/api/file/file.md b/docs/api/file/file.md index 2c0de5313d6f35d71cfe4086010dd84f150a1e45..411c225eb9fbeabd4bf286d8223e1dd9d06f003e 100644 --- a/docs/api/file/file.md +++ b/docs/api/file/file.md @@ -3,7 +3,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|√|√|√|√| @@ -45,7 +45,7 @@ uni.chooseImage({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|√|√|√|√| @@ -87,7 +87,7 @@ uni.getSavedFileList({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|√|√|x|√| @@ -125,7 +125,7 @@ uni.getSavedFileInfo({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|√|√|√|√| @@ -160,7 +160,7 @@ uni.getSavedFileList({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|√|√|√|√| @@ -187,7 +187,7 @@ uni.getSavedFileList({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|√|√|√|√| @@ -223,11 +223,12 @@ uni.downloadFile({ |平台|打开方式| |:-|:-| |小程序|在小程序的入口应用内打开| -|5+App iOS|在当前应用内打开| -|5+App Android|调用系统相关应用打开，无相关应用则不能打开| +|App iOS|在当前应用内打开| +|App Android|调用系统相关应用打开，无相关应用则不能打开| |H5|使用浏览器打开，当前浏览器不支持则不能打开| **Tips** - App端，io操作还可以用更强大的plus.io API。[https://www.html5plus.org/doc/zh_cn/io.html](https://www.html5plus.org/doc/zh_cn/io.html) - App端，打开各种格式的文件，如office、pdf等，还可以用更强大的三方插件，详见[插件市场](https://ext.dcloud.net.cn/search?q=pdf) +- 选择文件上传，uni-app有自带的api：[uni.chooseImage](https://uniapp.dcloud.io/api/media/image?id=chooseimage)和[uni.chooseVideo](https://uniapp.dcloud.io/api/media/video?id=choosevideo)。App端如需选择非媒体文件，可在插件市场搜索[文件选择](https://ext.dcloud.net.cn/search?q=文件选择)，其中Android端可以使用Native.js，无需原生插件，而iOS端需要原生插件。 diff --git a/docs/api/location/location.md b/docs/api/location/location.md index 1fb5720eaaed7bac065189dcc3f83c6f6c379f09..5612a6c99399764ffc6f339feda53605791014a6 100644 --- a/docs/api/location/location.md +++ b/docs/api/location/location.md @@ -54,10 +54,11 @@ uni.getLocation({ #### 注意 -- H5：在较新的手机浏览器上，H5 端获取定位信息，要求部署在 **https** 服务上，本地预览（localhost）仍然可以使用 http 协议。 -- H5：国产安卓手机上，H5若无非定位，检查手机是否开通位置服务、GPS，ROM是否给该浏览器位置权限、浏览器是否对网页弹出请求给予定位的询问框。 +- H5：在较新的浏览器上，H5 端获取定位信息，要求部署在 **https** 服务上，本地预览（localhost）仍然可以使用 http 协议。 +- H5：国产安卓手机上，H5若无法定位，检查手机是否开通位置服务、GPS，ROM是否给该浏览器位置权限、浏览器是否对网页弹出请求给予定位的询问框。 - H5：安卓手机在原生App内嵌H5时，无法定位需要原生App处理Webview。 -- H5：无 GPS 模块的 PC 设备使用 Chrome 浏览器的时候，位置信息是连接谷歌服务器获取的，国内用户可能获取位置信息失败。 +- H5：移动端浏览器普遍仅支持GPS定位，在GPS信号弱的地方可能定位失败。 +- H5：PC 设备使用 Chrome 浏览器的时候，位置信息是连接谷歌服务器获取的，国内用户可能获取位置信息失败。 - H5：使用坐标类型为 gcj02 时，需要配置腾讯地图 sdk 信息（manifest.json -> h5）。 - H5：微信公众号可使用微信js sdk，[详见](https://ask.dcloud.net.cn/article/35380) - App：Android由于谷歌服务被墙，想在国产手机上正常定位，需要向高德等三方服务商申请SDK资质，获取AppKey。云打包时需要在manifest的SDK配置中填写Appkey。在manifest可视化界面有详细申请指南，详见：[https://ask.dcloud.net.cn/article/29](https://ask.dcloud.net.cn/article/29)。离线打包自行在原生工程中配置。注意包名、appkey、证书信息必须匹配。 diff --git a/docs/api/media/audio-context.md b/docs/api/media/audio-context.md index cc5677634abd927fa69d807e24b399bf1a9e4e70..d383b9c404a9732ce38a622eab25feafca50a6dd 100644 --- a/docs/api/media/audio-context.md +++ b/docs/api/media/audio-context.md @@ -3,7 +3,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|√|√|x|√|√|√| @@ -95,3 +95,7 @@ innerAudioContext.onError((res) => { console.log(res.errCode); }); ``` + +**tips** + +如需音频的倍速播放，可通过video的倍速播放替代实现。插件市场有封装好的插件[音频倍速播放](https://ext.dcloud.net.cn/search?q=%E9%9F%B3%E9%A2%91%E5%80%8D%E9%80%9F%E6%92%AD%E6%94%BE) diff --git a/docs/api/media/background-audio-manager.md b/docs/api/media/background-audio-manager.md index 63c5b605ae99526d42dc676486384965b83b77e5..5d5261f433c75ddce63c1148baa5194888e1100f 100644 --- a/docs/api/media/background-audio-manager.md +++ b/docs/api/media/background-audio-manager.md @@ -3,7 +3,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|x|√|√|√| diff --git a/docs/api/media/image.md b/docs/api/media/image.md index 90a6b3d5f7ac1e9d0c82fbecc3fdce986f0a18d6..55492be0ffc1a22be92f19dca9f64648d5716def 100644 --- a/docs/api/media/image.md +++ b/docs/api/media/image.md @@ -1,8 +1,6 @@ ### uni.chooseImage(OBJECT) 从本地相册选择图片或使用相机拍照。 -另外选择和上传非图像、视频文件参考：[https://ask.dcloud.net.cn/article/35547](https://ask.dcloud.net.cn/article/35547)。 - App端如需要更丰富的相机拍照API（如直接调用前置摄像头），参考[plus.camera](https://www.html5plus.org/doc/zh_cn/camera.html) **OBJECT 参数说明** @@ -10,17 +8,19 @@ App端如需要更丰富的相机拍照API（如直接调用前置摄像头） |参数名|类型|必填|说明|平台差异说明| |:-|:-|:-|:-|:-| |count|Number|否|最多可以选择的图片张数，默认9|见下方说明| -|sizeType|Array<String>|否|original 原图，compressed 压缩图，默认二者都有|5+App、微信小程序、支付宝小程序、百度小程序| +|sizeType|Array<String>|否|original 原图，compressed 压缩图，默认二者都有|App、微信小程序、支付宝小程序、百度小程序| |sourceType|Array<String>|否|album 从相册选图，camera 使用相机，默认二者都有。如需直接开相机或直接选相册，请只使用一个选项|| |success|Function|是|成功则返回图片的本地文件路径列表 tempFilePaths|| -|fail|Function|否|接口调用失败的回调函数|小程序、5+App| +|fail|Function|否|接口调用失败的回调函数|小程序、App| |complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| | **Tips** -- count 值在 H5 平台的表现，基于浏览器本身的规范。目前测试的结果来看，只能限制单选/多选，并不能限制数量。并且，在实际的手机浏览器很少有能够支持多选的。 +- count 值在 H5 平台的表现，基于浏览器本身的规范。目前测试的结果来看，只能限制单选/多选，并不能限制数量。并且，在实际的手机浏览器很少有能够支持多选的。 - sourceType 在H5端对应`input`的`capture`属性，设置为`['album']`无效，依然可以使用相机。 - 可以通过用户授权API来判断用户是否给应用授予相册或摄像头的访问权限[https://uniapp.dcloud.io/api/other/authorize](https://uniapp.dcloud.io/api/other/authorize) +- App端如需选择非媒体文件，可在插件市场搜索[文件选择](https://ext.dcloud.net.cn/search?q=文件选择)，其中Android端可以使用Native.js，无需原生插件，而iOS端需要原生插件。 + **注：文件的临时路径，在应用本次启动期间可以正常使用，如需持久保存，需在主动调用 [uni.saveFile](api/file/file?id=savefile)，在应用下次启动时才能访问得到。** @@ -61,9 +61,9 @@ uni.chooseImage({ |:-|:-|:-|:-|:-| |current|String/Number|详见下方说明|详见下方说明|| |urls|Array<String>|是|需要预览的图片链接列表|| -|indicator|String|否|图片指示器样式，可取值："default" - 底部圆点指示器； "number" - 顶部数字指示器； "none" - 不显示指示器。|5+App| -|loop|Boolean|否|是否可循环预览，默认值为 false|5+App| -|longPressActions|Object|否|长按图片显示操作菜单，如不填默认为**保存相册**，1.9.5 起支持。|5+App| +|indicator|String|否|图片指示器样式，可取值："default" - 底部圆点指示器； "number" - 顶部数字指示器； "none" - 不显示指示器。|App| +|loop|Boolean|否|是否可循环预览，默认值为 false|App| +|longPressActions|Object|否|长按图片显示操作菜单，如不填默认为**保存相册**|App 1.9.5+| |success|Function|否|接口调用成功的回调函数|| |fail|Function|否|接口调用失败的回调函数|| |complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| | @@ -135,7 +135,7 @@ uni.chooseImage({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| |√|√|√|√|√|√| @@ -194,9 +194,9 @@ uni.chooseImage({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序 +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序 |:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|x|√|√| +|√|x|√|√|√|√| **OBJECT 参数说明** @@ -240,7 +240,7 @@ uni.chooseImage({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序 +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序 |:-:|:-:|:-:|:-:|:-:|:-:| |1.9.7+ [自定义组件编译模式](https://ask.dcloud.net.cn/article/35843)|x|√|√|√(基础库版本>=3.110.3)|√| diff --git a/docs/api/media/live-player-context.md b/docs/api/media/live-player-context.md index 4f54615e7c6a1a7e66db73178c593f79b6f91a73..ec1d3ec4302610380c681753c6735a9f2215989f 100644 --- a/docs/api/media/live-player-context.md +++ b/docs/api/media/live-player-context.md @@ -54,7 +54,7 @@ App平台的直播播放，不使用此API，而直接使用video的API。 |App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|见下|x|√|x|x|x|x| +|见下|x|√|x|x|x|√| - app-nvue 平台 2.2.5+ 支持 uni.createLivePusherContext(livePusherId, this) - app-nvue 平台 2.2.5以下，需要同时设置组件属性id和ref ````，或者直接使用 ref，例如 ``this.$refs.livepusher1`` diff --git a/docs/api/media/record-manager.md b/docs/api/media/record-manager.md index 03234fd3a09907890bf578ccac5e8c4a9caec172..bda78e24ef55e5b25e28af1cf4d488166441624c 100644 --- a/docs/api/media/record-manager.md +++ b/docs/api/media/record-manager.md @@ -3,7 +3,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|x|√|√|√| @@ -18,7 +18,7 @@ |onStart|callback|录音开始事件|| |onPause|callback|录音暂停事件|| |onStop|callback|录音停止事件，会回调文件地址|| -|onFrameRecorded|callback|已录制完指定帧大小的文件，会回调录音分片结果数据。如果设置了 frameSize ，则会回调此事件|5+App 暂不支持| +|onFrameRecorded|callback|已录制完指定帧大小的文件，会回调录音分片结果数据。如果设置了 frameSize ，则会回调此事件|App 暂不支持| |onError|callback|录音错误事件, 会回调错误信息| | **start(options) 说明** diff --git a/docs/api/media/video.md b/docs/api/media/video.md index cb8c138822f655c462041f1db4e4bfafad464cee..990c7fad980eaafc07e42a022aca8580bf6c1fb2 100644 --- a/docs/api/media/video.md +++ b/docs/api/media/video.md @@ -74,7 +74,7 @@ export default { |App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|x|√|√|√| +|√|x|√|√|√|√|√| **OBJECT 参数说明** diff --git a/docs/api/other/authorize.md b/docs/api/other/authorize.md index cd96d18f8cd2494deaaf587759b8cac2ce9217c9..4ed217ef24cec6f251aca70e6b9aa1bb3eb78db5 100644 --- a/docs/api/other/authorize.md +++ b/docs/api/other/authorize.md @@ -1,6 +1,6 @@ ### uni.authorize(OBJECT) -提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。 +提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。如果用户之前拒绝了授权，此接口会直接进入失败回调，一般搭配`uni.getSetting`和`uni.openSetting`使用。 **平台差异说明** diff --git a/docs/api/other/choose-address.md b/docs/api/other/choose-address.md index c554d053890c3e9acb6a9b58db34ed27dcdeb1df..a47dc8398a4485d2459be15e18be8c261d1fcdf8 100644 --- a/docs/api/other/choose-address.md +++ b/docs/api/other/choose-address.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|√|x| +|x|x|√|√|√|√|x| **OBJECT参数说明** diff --git a/docs/api/other/get-extconfig.md b/docs/api/other/get-extconfig.md index 7bce3d799b1bcd818267dd60e4ca4d18c0634d1d..b9980a7d26c6de45f1f9325703b28dd5c35f590f 100644 --- a/docs/api/other/get-extconfig.md +++ b/docs/api/other/get-extconfig.md @@ -4,7 +4,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|√|x| @@ -45,7 +45,7 @@ if (uni.getExtConfig) { **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|√|x| diff --git a/docs/api/other/getAccountInfoSync.md b/docs/api/other/getAccountInfoSync.md index 08c8fda74368ae15663b80f511a4807e2ef672a6..f7900e828c030051ee43d20b05bd3837b9fcf15e 100644 --- a/docs/api/other/getAccountInfoSync.md +++ b/docs/api/other/getAccountInfoSync.md @@ -5,7 +5,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|x|√| diff --git a/docs/api/other/invoice-title.md b/docs/api/other/invoice-title.md index 71bbe04c21c1484390ee7c4e96476e9020e4d7e0..0758c4c0b2594f61729b3c8d29f68549eaf3b33b 100644 --- a/docs/api/other/invoice-title.md +++ b/docs/api/other/invoice-title.md @@ -6,7 +6,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|x|x| diff --git a/docs/api/other/open-miniprogram.md b/docs/api/other/open-miniprogram.md index e34b98cb8b8c5e1fdb756629f1307667255995b2..b8e48370622616ec8c034eb1a72720fa149f19b0 100644 --- a/docs/api/other/open-miniprogram.md +++ b/docs/api/other/open-miniprogram.md @@ -46,7 +46,7 @@ uni.navigateToMiniProgram({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|√|√|√|√| diff --git a/docs/api/other/reportAnalytics.md b/docs/api/other/reportAnalytics.md index f217704a15c927fe1c272acfb3c54118491753d5..1151feb39e3006678020e830825abb0bd788b2c1 100644 --- a/docs/api/other/reportAnalytics.md +++ b/docs/api/other/reportAnalytics.md @@ -1,6 +1,7 @@ -#### wx.reportAnalytics(string eventName, Object data) +#### uni.reportAnalytics(string eventName, Object data) 自定义分析数据上报接口。使用前，需要在小程序管理后台自定义分析中新建事件，配置好事件名与字段。。 -仅微信小程序平台支持，[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.reportAnalytics.html) \ No newline at end of file +微信小程序平台[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.reportAnalytics.html) +QQ小程序平台[规范详情](https://q.qq.com/wiki/develop/game/API/open-port/port_dataanalysis.html#qq-reportanalytics) \ No newline at end of file diff --git a/docs/api/other/reportMonitor.md b/docs/api/other/reportMonitor.md index b6cdf86022ac7f6d745eb5a1be934d16c81ac45b..9eda4151c412474f5f031db015356af871c939d6 100644 --- a/docs/api/other/reportMonitor.md +++ b/docs/api/other/reportMonitor.md @@ -1,6 +1,7 @@ -#### wx.reportMonitor() +#### uni.reportMonitor() 自定义业务数据监控上报接口。 -仅微信小程序平台支持，[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.reportMonitor.html) \ No newline at end of file +微信小程序平台[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.reportMonitor.html) +QQ小程序平台[规范详情](https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_dataup.html#qq-reportmonitor) diff --git a/docs/api/other/requestSubscribeMessage.md b/docs/api/other/requestSubscribeMessage.md new file mode 100644 index 0000000000000000000000000000000000000000..f65dd576dc2a6f2a318e7d660d38d77a9c8666dd --- /dev/null +++ b/docs/api/other/requestSubscribeMessage.md @@ -0,0 +1,49 @@ +### uni.requestSubscribeMessage(Object object) + + +**平台差异说明** + +|App|H5 |微信小程序 |支付宝小程序 |百度小程序 |头条小程序 |QQ小程序 | +|:-: |:-:|:-: |:-: |:-: |:-: |:-: | +|x |x |基础库版本>=2.8.2|x |x |x |x | + +**object参数说明** + +|属性 |类型 |默认值 |必填 |说明 | +|:-: |:-: |:-: |:-: |:-: | +|tmplIds |Array | |是 |需要订阅的消息模板的id的集合，一次调用最多可订阅3条消息（注意：iOS客户端7.0.6版本、Android客户端7.0.7版本之后的一次性订阅/长期订阅才支持多个模板消息，iOS客户端7.0.5版本、Android客户端7.0.6版本之前的一次订阅只支持一个模板消息）消息模板id在[微信公众平台(mp.weixin.qq.com)-功能-订阅消息]中配置 | +|success |function | |否 |接口调用成功的回调函数 | +|fail |function | |否 |接口调用失败的回调函数 | +|complete |function | |否 |接口调用结束的回调函数（调用成功、失败都会执行） | + + +**注意** + +- 用户发生点击行为或者发起支付回调后，才可以调起订阅消息界面 + +**平台说明** + +- [微信小程序订阅消息参考文档](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/subscribe-message.html) + + +**object.success 返回值** + +|属性 |类型 |说明 | +|:-: |:-: |:-: | +|errMsg |String |接口调用成功时errMsg值为'requestSubscribeMessage:ok' | +|TEMPLATE_ID|String| [TEMPLATE_ID]是动态的键，即模板id，值包括'accept'、'reject'、'ban'。'accept'表示用户同意订阅该条id对应的模板消息，'reject'表示用户拒绝订阅该条id对应的模板消息，'ban'表示已被后台封禁。例如 { errMsg: "requestSubscribeMessage:ok", zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: "accept"} 表示用户同意订阅zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE这条消息| + +**object.fail 返回值** + +|属性 |类型 |说明 | +|:-: |:-: |:-: | +|errMsg |String |接口调用失败错误信息 | +|errCode|Number |接口调用失败错误码 | + +**示例代码** +``` +uni.requestSubscribeMessage({ + tmplIds: [''], + success (res) { } +}) +``` \ No newline at end of file diff --git a/docs/api/other/set-enable-debug.md b/docs/api/other/set-enable-debug.md index 3053a9a89e975ff206e381946079bf79c6f59d16..07c0d6489268680e58dbc73fb708705c61b8e978 100644 --- a/docs/api/other/set-enable-debug.md +++ b/docs/api/other/set-enable-debug.md @@ -4,7 +4,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|x|√| diff --git a/docs/api/other/setting.md b/docs/api/other/setting.md index 3429d902c748ca74fcac28dc14f4f8c020385ba5..35549be26afee72bcfed57252047ceb785a36aa8 100644 --- a/docs/api/other/setting.md +++ b/docs/api/other/setting.md @@ -4,7 +4,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|√|√|√|√| @@ -35,7 +35,7 @@ uni.openSetting({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|√|√|√|√| diff --git a/docs/api/other/template.md b/docs/api/other/template.md index 087a25dca667f38a8384c637cd2b8d96e38060d3..e385548af47704e8941e748e594b58f6f7ecf85a 100644 --- a/docs/api/other/template.md +++ b/docs/api/other/template.md @@ -4,7 +4,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|x|x| @@ -66,7 +66,7 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/templateadd?access_tok **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|x|x| @@ -120,7 +120,7 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/templatedel?access_tok **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|x|x| @@ -229,7 +229,7 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/libraryget?access_toke **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|x|x| @@ -318,7 +318,7 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/librarylist?access_tok **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|x|x| @@ -416,7 +416,7 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/templatelist?access_to **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|x|x| @@ -549,7 +549,7 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/templatedel?access_tok **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|x|√|x|x|x| diff --git a/docs/api/other/update.md b/docs/api/other/update.md index 4acc78c2ecc9960f3b6b7afd89ccf12bc9c63754..114a1a9c12413fe7d248cf43c0073b17438294f3 100644 --- a/docs/api/other/update.md +++ b/docs/api/other/update.md @@ -8,7 +8,7 @@ App的更新不使用本API，另见文档： **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|√|√|√|√| diff --git a/docs/api/plugins/login.md b/docs/api/plugins/login.md index 10dbb6ded35b37bc6623b4983991c31472297395..3257fc72d809f8cbd95aa44b903b2b43d0c85ae4 100644 --- a/docs/api/plugins/login.md +++ b/docs/api/plugins/login.md @@ -3,7 +3,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|√|√|√|√| @@ -33,11 +33,11 @@ H5平台登陆注意事项： 各个平台的登录流程存在差异，详细请参考相关平台的文档说明： * [微信小程序登录](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html) -* [支付宝小程序用户授权](https://docs.alipay.com/mini/introduce/auth) +* [支付宝小程序用户授权](https://docs.alipay.com/mini/introduce/authcode) * [百度小程序登录](https://smartprogram.baidu.com/docs/develop/api/open_log/#%E6%8E%88%E6%9D%83%E6%B5%81%E7%A8%8B%E8%AF%B4%E6%98%8E/) -* [头条小程序登录](https://developer.toutiao.com/dev/cn/mini-app/develop/open-capacity/log-in/login) -* [Apple登录](https://ask.dcloud.net.cn/article/36651) - +* [头条小程序登录](https://developer.toutiao.com/dev/cn/mini-app/develop/open-capacity/log-in/login) +* [Apple登录、苹果登录、Sign in with Apple](https://ask.dcloud.net.cn/article/36651) + **示例** @@ -58,7 +58,7 @@ uni.login({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√|x|√|√|√| @@ -75,7 +75,7 @@ uni.login({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|√|√|√|√| @@ -87,7 +87,7 @@ uni.login({ |:-|:-|:-|:-|:-|:-| |provider|String|否|登录服务提供商，通过 uni.getProvider 获取|| |withCredentials|Boolean|否|是否带上登录态信息。|微信小程序、头条小程序| -|lang|Number|否|指定返回用户信息的语言，默认为 en。更多值请参考下面的说明。|微信小程序| +|lang|String|否|指定返回用户信息的语言，默认为 en。更多值请参考下面的说明。|微信小程序| |timeout|Number|否|超时时间，单位 ms。|微信小程序| |success|Function|否|接口调用成功的回调|| |fail|Function|否|接口调用失败的回调函数|| @@ -101,7 +101,7 @@ uni.login({ |zh_TW|繁体中文| |en|英文| -**注意：**在小程序 withCredentials 为 true 时或是在 5+App 调用 uni.getUserInfo，要求此前有调用过 uni.login 且登录态尚未过期。 +**注意：**在小程序 withCredentials 为 true 时或是在 App 调用 uni.getUserInfo，要求此前有调用过 uni.login 且登录态尚未过期。 **success 返回参数说明** @@ -119,7 +119,7 @@ uni.login({ |参数|类型|说明|平台差异说明| |:-|:-|:-|| |nickName|String|用户昵称|| -|openId|String|该服务商唯一用户标识|5+App| +|openId|String|该服务商唯一用户标识|App| |avatarUrl|String|用户头像| | 除了以上三个必有的信息外，不同服务供应商返回的其它信息会存在差异。 diff --git a/docs/api/plugins/payment.md b/docs/api/plugins/payment.md index f91574c58fd3af8aff838917a3e5d13cdd6560ea..24d48f561dd15c5a7b98ce04eaf7e1ff40dcbc69 100644 --- a/docs/api/plugins/payment.md +++ b/docs/api/plugins/payment.md @@ -11,7 +11,7 @@ uni.requestPayment是一个统一各平台的客户端支付API，不管是在 **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|[说明](/api/plugins/payment?id=h5-payment)|√|√|√|√|√| @@ -20,7 +20,7 @@ uni.requestPayment是一个统一各平台的客户端支付API，不管是在 |参数名|类型|必填|说明|平台差异说明| |:-|:-|:-|:-|| |provider|String|是|服务提供商，通过 [uni.getProvider](/api/plugins/provider) 获取。|| -|orderInfo|String/Object|是|订单数据，[注意事项](/api/plugins/payment?id=orderinfo)|5+App、支付宝小程序、百度小程序、头条小程序| +|orderInfo|String/Object|是|订单数据，[注意事项](/api/plugins/payment?id=orderinfo)|App、支付宝小程序、百度小程序、头条小程序| |timeStamp|String|微信小程序必填|时间戳从1970年1月1日至今的秒数，即当前的时间。|微信小程序| |nonceStr|String|微信小程序必填|随机字符串，长度为32个字符以下。|微信小程序| |package|String|微信小程序必填|统一下单接口返回的 prepay_id 参数值，提交格式如：prepay_id=xx。|微信小程序| @@ -41,9 +41,10 @@ uni.requestPayment是一个统一各平台的客户端支付API，不管是在 #### orderInfo 注意事项@orderInfo 1. 百度小程序的 orderInfo 为 Object 类型，详细的数据结构，参考：[百度收银台支付](https://smartprogram.baidu.com/docs/develop/api/open_payment/#requestPolymerPayment/)。 2. 支付宝小程序的 orderInfo(支付宝的规范为 tradeNO) 为 String 类型，表示支付宝交易号。 -3. 头条小程序的 orderInfo(头条的规范为 data) 为 Object 类型，详见：[发起头条支付](https://developer.toutiao.com/dev/cn/mini-app/develop/open-capacity/payment/pay) -4. App端，支付宝支付和微信支付 orderInfo 均为 String 类型。 -5. App端，苹果应用内支付 orderInfo 为Object 类型，{productid: 'productid'}。 +3. 头条小程序的 orderInfo 为 Object 类型，详见：[发起头条支付](https://developer.toutiao.com/dev/cn/mini-app/develop/open-capacity/payment/pay) +4. 由于头条新版支付接口要求版本较高，在不支持新版支付接口的情况下仍会对应旧版支付接口，此时 orderInfo 对应头条小程序 data， 详见：[头条支付旧版接口](https://developer.toutiao.com/dev/cn/mini-app/develop/open-capacity/payment/requestpayment-deprecated)。用户可以使用 tt.pay 判断是否支持新版接口。另外需要注意头条小程序在`1.35.0+`版本基础库支持了 canIUse ，在`1.19.4+`版本基础库支持了新版支付接口 tt.pay ，所以应避免使用 canIUse 判断是否为新版接口。 +5. App端，支付宝支付和微信支付 orderInfo 均为 String 类型。 +6. App端，苹果应用内支付 orderInfo 为Object 类型，{productid: 'productid'}。 #### H5 平台@h5-payment - 普通浏览器平台的支付，仍然是常规web做法。uni-app未封装。 diff --git a/docs/api/plugins/provider.md b/docs/api/plugins/provider.md index 065a6cddc36d4b7972b6db6a4e37eb2d82a01ce8..a10e6f106164078f08f38399f461005d34c74723 100644 --- a/docs/api/plugins/provider.md +++ b/docs/api/plugins/provider.md @@ -1,15 +1,15 @@ ### uni.getProvider(OBJECT) -获取服务供应商。仅App平台支持。 +获取服务供应商。 -在App平台，可用的服务商，是打包环境中配置的服务商，与手机端安装了什么app没有关系。 +在App平台，可用的服务商，是打包环境中配置的服务商，与手机端是否安装了该服务商的App没有关系。 云打包在manifest中配置相关模块和SDK信息，离线打包在原生工程中配置。某个服务商配置被打包进去，运行时就能得到相应的服务供应商。 **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|√| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-|:-|:-|:-|:-|:-|:-| +|√|x|√|√|√|√|√| **OBJECT 参数说明** @@ -45,8 +45,8 @@ |oauth|weixin|微信登录|| ||qq|QQ登录|| ||sinaweibo|新浪微博登录|| -||xiaomi|小米登录|| -||apple|[Apple登录](https://ask.dcloud.net.cn/article/36651)|| +||xiaomi|小米登录|| +||apple|[Apple登录](https://ask.dcloud.net.cn/article/36651)|仅iOS13支持，HBuilderX 2.4.7+| |share|sinaweibo|新浪微博分享|| ||qq|分享到QQ好友|| ||weixin|分享微信消息、朋友圈及微信小程序|| @@ -79,4 +79,4 @@ uni.getProvider({ } } }); -``` \ No newline at end of file +``` diff --git a/docs/api/plugins/push.md b/docs/api/plugins/push.md index 888c9714fa061d6e7d8cfef74ec827cf81d4da0a..a7cbeefdf7ffe57b63483b0f439f88909499b451 100644 --- a/docs/api/plugins/push.md +++ b/docs/api/plugins/push.md @@ -49,7 +49,7 @@ 开启推送 平台差异说明： -- 5+App +- App **OBJECT 参数说明** @@ -87,7 +87,7 @@ uni.getProvider({ **平台差异说明** -- 5+App +- App **OBJECT 参数说明** @@ -115,7 +115,7 @@ uni.unsubscribePush({ **平台差异说明** -- 5+App +- App **OBJECT 参数说明** @@ -147,7 +147,7 @@ uni.onPush({ **平台差异说明** -- 5+App +- App **OBJECT 参数说明** diff --git a/docs/api/plugins/share.md b/docs/api/plugins/share.md index 4df6b14fbf27251a2f009a3ed9ce79f5730e668d..eb07fb71e1ebf9a418fc607b6660339ba630229d 100644 --- a/docs/api/plugins/share.md +++ b/docs/api/plugins/share.md @@ -5,8 +5,8 @@ |平台|说明| |:-|:-| -|App|使用 ``uni.share`` 进行分享，需要在 `manifest.json` 里配置各平台分享所必需的的字段，如appid、appsecret等| -|小程序|不支持方法调用，只能用户主动点击触发分享，可使用