diff --git a/docs/.vuepress/config/navbar.js b/docs/.vuepress/config/navbar.js index f14d31702674bdeb8849fdbcbd79e6a3012df229..896a8cc3295bb1128d3167caee8a7fc210475b4b 100644 --- a/docs/.vuepress/config/navbar.js +++ b/docs/.vuepress/config/navbar.js @@ -37,11 +37,6 @@ export const navbar = [ type: 'link', link: '/api/' }, - { - text: 'UTS', - type: 'link', - link: '/uni-app-x/uts/' - }, { text: '插件', type: 'link', @@ -52,6 +47,11 @@ export const navbar = [ type: 'link', link: '/worktile/' }, + { + text: 'UTS', + type: 'link', + link: 'https://doc.dcloud.net.cn/uni-app-x/uts/' + }, { text: '其他规范', type: 'links', @@ -134,64 +134,17 @@ export const navbar = [ }, { text: 'uni-app x', - link: '/uni-app-x/', - items: [ - { - text: '介绍', - type: 'link', - link: '/uni-app-x/' - }, - { - text: '编译器', - type: 'link', - link: '/uni-app-x/compiler/' - }, - { - text: 'UTS', - type: 'link', - link: '/uni-app-x/uts/' - }, - { - text: '全局文件', - type: 'link', - link: '/uni-app-x/collocation/pagesjson' - }, - { - text: '组件', - type: 'link', - link: '/uni-app-x/component/' - }, - { - text: 'API', - type: 'link', - link: '/uni-app-x/api/' - }, - { - text: 'CSS', - type: 'link', - link: '/uni-app-x/css/' - }, - { - text: 'DOM', - type: 'link', - link: '/uni-app-x/dom/' - }, - { - text: '插件', - type: 'link', - link: '/uni-app-x/plugin/' - }, - { - text: '工程化', - type: 'link', - link: '/uni-app-x/worktile/' - } - ] + link: 'https://doc.dcloud.net.cn/uni-app-x/', + type: "link", + target: '_blank', + needOutbound: false }, { text: 'uniCloud', - type: 'link', - link: '/uniCloud/' + link: 'https://doc.dcloud.net.cn/uniCloud/', + type: "link", + target: '_blank', + needOutbound: false }, { text: 'HBuilder', diff --git a/docs/.vuepress/config/redirectRouter.js b/docs/.vuepress/config/redirectRouter.js index 17d0c7d278f3484b540af68b3a9416a45263d12e..eaf27ae75b9f92563bfae10499588f57de0bd7ee 100644 --- a/docs/.vuepress/config/redirectRouter.js +++ b/docs/.vuepress/config/redirectRouter.js @@ -70,10 +70,6 @@ const routerMap = { '/nvue-api': '/tutorial/nvue-api.html', '/nvue-css': '/tutorial/nvue-css.html', - '/uniCloud/database': '/uniCloud/clientdb.html', - '/uniCloud/uni-clientDB': '/uniCloud/clientdb.html', - '/uniCloud/uni-data-picker': '/component/uniui/uni-data-picker.html', - '/uniCloud/uni-push/introduction.html': '/unipush-v2.html', '/plugin/publish#pages-init': '/plugin/uni_modules.html#pages-init', '/tutorial/build/uni-app-publish-mp-weixin': '/tutorial/build/publish-mp-weixin-cli.html', @@ -93,14 +89,9 @@ const routerMap = { '/m3w': '/uniCloud/uni-portal.html', '/tutorial/syntax-uts': '/uni-app-x/uts/', - '/uniCloud/uni-id-summary': '/uniCloud/uni-id/summary.html', - '/uniCloud/uni-id-pages': '/uniCloud/uni-id/redirect.html', - '/uniCloud/uni-id-common': '/uniCloud/uni-id/cloud-common.html', - '/uniCloud/uni-id': '/uniCloud/uni-id/old.html', + '/uniCloud/': 'https://doc.dcloud.net.cn/uniCloud/', '/uts/': '/uni-app-x/uts/', - '/uni-app-x/ext': '/uni-app-x/api/ext.html', - '/uni-app-x/pagesjson': '/uni-app-x/collocation/pagesjson.html', - '/uni-app-x/manifest': '/uni-app-x/collocation/manifest.html' + '/uni-app-x/': 'https://doc.dcloud.net.cn/uni-app-x/' } export default ({ fullPath, path, hash }) => { diff --git a/docs/.vuepress/config/searchPage.js b/docs/.vuepress/config/searchPage.js index c79aad2ccbbca0ab9aeeb3cb8470e034c1a0046d..2b35bd788becb8d550d5a896c88b467b42bae8ea 100644 --- a/docs/.vuepress/config/searchPage.js +++ b/docs/.vuepress/config/searchPage.js @@ -4,14 +4,14 @@ export default { text: 'uni-app', type: 'algolia', }, - { + /* { text: 'uni-app x', type: 'algolia', }, { text: 'uniCloud', type: 'algolia', - }, + }, */ { text: '问答社区', tag: 'ask', diff --git a/docs/.vuepress/config/siderbar/index.js b/docs/.vuepress/config/siderbar/index.js index 02f11d035356d1ff536fba40c82c2c6874912886..94d0c7c40e612fc0268b67c715e6d56cdfb8832e 100644 --- a/docs/.vuepress/config/siderbar/index.js +++ b/docs/.vuepress/config/siderbar/index.js @@ -3,7 +3,7 @@ import uniCloud from './uniCloud'; export default { "/": uniapp, - "/uni-app-x/": uniapp, - '/uniCloud/': uniCloud, + // "/uni-app-x/": uniapp, + // '/uniCloud/': uniCloud, weChatOfficialAccountImg: 'https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/weixin.jpg' } diff --git a/docs/.vuepress/utils/index.js b/docs/.vuepress/utils/index.js index 7b34b09ffc7a80efbd24364b5d700b399fde21de..57f24eb75eb3d304bd769f84d050b7a5be2d8ffc 100644 --- a/docs/.vuepress/utils/index.js +++ b/docs/.vuepress/utils/index.js @@ -16,8 +16,6 @@ function simplifySlugText(text) { // 顺序有要求,会影响 for 循环匹配侧边栏 const tabs = [ - '/uni-app-x/compiler/', '/uni-app-x/dom/', '/uni-app-x/uts/', '/uni-app-x/collocation/', '/uni-app-x/plugin/', '/uni-app-x/worktile/', '/uni-app-x/component/', '/uni-app-x/api/', '/uni-app-x/css/', '/uni-app-x/', - '/uniCloud/', '/plugin/', '/worktile/', '/tutorial/', '/collocation/', '/component/', '/api/', '/', ] diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 6e6ee29cf6012139bf6b9bf29b75357c5e5847c2..b771693f87554f5af3a56a784012c8181b7cf4c5 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -25,11 +25,11 @@ * [微信小程序互动广告](uni-ad/ad-interactive.md) * [广告错误码](uni-ad/ad-error-code.md) * [uni-ad管理后台更新说明](uni-ad/release.md) - * [统一发行页面](/uniCloud/uni-portal.md) - * [前端网页托管](uniCloud/hosting.md) - * [App升级中心](uniCloud/upgrade-center.md) + * [统一发行页面](https://doc.dcloud.net.cn/uniCloud/uni-portal.html) + * [前端网页托管](https://doc.dcloud.net.cn/uniCloud/hosting.html) + * [App升级中心](https://doc.dcloud.net.cn/uniCloud/upgrade-center.html) * [uni一键登录](univerify.md) - * [uni实人认证](uniCloud/frv/intro.md) + * [uni实人认证](https://doc.dcloud.net.cn/uniCloud/frv/intro.html) * [uni-push统一推送](unipush.md) * [uni-push1.0](unipush-v1.md) * [uni-push2.0](unipush-v2.md) @@ -38,7 +38,7 @@ * [uni-app客户端api](https://uniapp.dcloud.net.cn/api/plugins/push.html) * [uni-app x客户端api](https://uniapp.dcloud.net.cn/uni-app-x/api/push.html) * [服务端api](https://uniapp.dcloud.net.cn/uniCloud/uni-cloud-push/api.html) - * [uni-push2.0、uni-id、uni统计的组合](uniCloud/uni-cloud-push/mate.md) + * [uni-push2.0、uni-id、uni统计的组合](https://doc.dcloud.net.cn/uniCloud/uni-cloud-push/mate.html) * [uni统计](uni-stat.md) * [uni统计2.0](uni-stat-v2.md) * [uni统计1.0](uni-stat-v1.md)` diff --git a/docs/api/plugins/facialRecognitionVerify.md b/docs/api/plugins/facialRecognitionVerify.md index 054c3c3a7ba04758406e2ec2581c9ce588dfc40b..6c1e68ae845a81a577133f62ad7c60c868a29c20 100644 --- a/docs/api/plugins/facialRecognitionVerify.md +++ b/docs/api/plugins/facialRecognitionVerify.md @@ -1,14 +1,14 @@ 实人认证提供核验终端操作者的真实身份,包含活体检测和人脸对比等生物识别技术,可快速校验自然人的真实身份。 -App平台端详细文档需另见:[业务介绍](/uniCloud/frv/intro.md)、[开发指南](/uniCloud/frv/dev.md) -微信小程序端业务开发流程,请参考[微信人脸核身接口能力](https://developers.weixin.qq.com/community/business/doc/000442d352c1202bd498ecb105c00d) +App平台端详细文档需另见:[业务介绍](https://doc.dcloud.net.cn/uniCloud/frv/intro.md)、[开发指南](https://doc.dcloud.net.cn/uniCloud/frv/dev.html) +微信小程序端业务开发流程,请参考[微信人脸核身接口能力](https://developers.weixin.qq.com/community/business/doc/000442d352c1202bd498ecb105c00d) -### uni.getFacialRecognitionMetaInfo() +### uni.getFacialRecognitionMetaInfo() uni.getFacialRecognitionMetaInfo是客户端API,获取实人认证设备信息,用于uniCloud云函数[getCertifyId](https://uniapp.dcloud.net.cn/uniCloud/frv/dev.html#get-certify-id)获取certifyId。 -App端API规范参考:[详情](/uniCloud/frv/dev.md#get-meta-info) +App端API规范参考:[详情](https://doc.dcloud.net.cn/uniCloud/frv/dev.html#get-meta-info) **平台说明** @@ -16,12 +16,12 @@ App端API规范参考:[详情](/uniCloud/frv/dev.md#get-meta-info) |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√(3.7.4+)|x|x|x|x|x|x|x|x| -### uni.startFacialRecognitionVerify(OBJECT) -实人认证 +### uni.startFacialRecognitionVerify(OBJECT) +实人认证 -uni.startFacialRecognitionVerify是客户端API,在App端打开刷脸认证界面。 +uni.startFacialRecognitionVerify是客户端API,在App端打开刷脸认证界面。 -App端API规范参考:[详情](/uniCloud/frv/dev.md#start-frv) +App端API规范参考:[详情](https://doc.dcloud.net.cn/uniCloud/frv/dev.html#start-frv) **平台说明** diff --git a/docs/api/plugins/login.md b/docs/api/plugins/login.md index f224e6f1f2bcc733e309564d121bc327ecbcf21f..ef312e8925e288617cf38867de5af0074b644ac5 100644 --- a/docs/api/plugins/login.md +++ b/docs/api/plugins/login.md @@ -3,7 +3,7 @@ uni.login是一个客户端API,统一封装了各个平台的各种常见的登录方式,包括App手机号一键登陆、三方登录(微信、微博、QQ、Apple、google、facebook)、各家小程序内置登录。 -除了前端API,DCloud还提供了[uni-id](/uniCloud/uni-id/summary.md),这是一个云端一体的、完整的、账户开源框架。不仅包括客户端API,还包括前端页面、服务器代码、管理后台等所有与登录账户有关的服务,包括短信验证码、密码加密存储、忘记密码、头像更新等所有常见账户相关功能。 +除了前端API,DCloud还提供了[uni-id](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html),这是一个云端一体的、完整的、账户开源框架。不仅包括客户端API,还包括前端页面、服务器代码、管理后台等所有与登录账户有关的服务,包括短信验证码、密码加密存储、忘记密码、头像更新等所有常见账户相关功能。 **平台差异说明** @@ -32,7 +32,7 @@ uni.login是一个客户端API,统一封装了各个平台的各种常见的 * [京东小程序登录](https://mp-docs.jd.com/api/openInterface/login.html) #### web平台支持的登录方式 -Web平台常见的登录包括用户名密码、短信验证码、pc端微信扫描、微信公众号登录。这些没有封装在 uni.login API中,但都封装在了uni-id中。请另行参考[uni-id](/uniCloud/uni-id/summary.md) +Web平台常见的登录包括用户名密码、短信验证码、pc端微信扫描、微信公众号登录。这些没有封装在 uni.login API中,但都封装在了uni-id中。请另行参考[uni-id](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html) 如不使用uni-id,微信内嵌浏览器运行H5版时,可通过js sdk实现微信登录,需要引入一个单独的js,[详见](https://ask.dcloud.net.cn/article/35380) @@ -234,7 +234,7 @@ uni.login({ |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |x|x|√(基础库2.10.4)|x|x|√(基础库2.30.0)|x|x|x| -**注意:** +**注意:** - 如业务需获取用户头像昵称,可以使用[「头像昵称填写能力」](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/userProfile.html)(基础库 2.21.2 版本开始支持,覆盖iOS与安卓微信 8.0.16 以上版本)。 - 该API仅支持微信小程序端(基础库2.10.4-2.27.0版本),微信小程序调整了相关接口(详见[《小程序登录、用户信息相关接口调整说明》](https://developers.weixin.qq.com/community/develop/doc/000cacfa20ce88df04cb468bc52801?highLine=getUserProfile%253Afail))。每次触发 uni.getUserProfile 均会弹出授权窗口,用户授权后可成功获取用户信息。该API暂不支持在事件中使用异步操作,否则会触发错误:{errMsg: "getUserProfile:fail can only be invoked by user TAP gesture."} diff --git a/docs/api/plugins/push.md b/docs/api/plugins/push.md index 42a674942661426346955822bb243b0368c366e1..8d0fa94ad62cebf296227b82d1771b0fd9758c4a 100644 --- a/docs/api/plugins/push.md +++ b/docs/api/plugins/push.md @@ -30,15 +30,15 @@ |:-|:-|:-| |errMsg|String| 错误描述| -常见报错: -`getPushClientId:fail register fail: {\"errorCode\":1,\"errorMsg\":\"\"}` -请检查: +常见报错: +`getPushClientId:fail register fail: {\"errorCode\":1,\"errorMsg\":\"\"}` +请检查: 1. 当前应用是否已开通uni-push2.0 [详情参考](https://uniapp.dcloud.io/unipush-v2.html#%E7%AC%AC%E4%B8%80%E6%AD%A5-%E5%BC%80%E9%80%9A) 2. 客户端对应平台是否已启用uni-push2.0[详情参考](https://uniapp.dcloud.io/unipush-v2.html#%E5%AE%A2%E6%88%B7%E7%AB%AF%E5%90%AF%E7%94%A8unipush2-0) 3. HBuilderX3.5.1 App平台vue3项目首次启动调用uni.getPushClientId 存在可能获取不到cid的问题,HBuilderX3.5.2修复了此问题,请升级。 示例代码: -```js +```js uni.getPushClientId({ success: (res) => { console.log(res.cid); @@ -53,7 +53,7 @@ ### uni.onPushMessage(callback)@onPushMessage 启动监听推送消息事件 代码示例: -```js +```js uni.onPushMessage((res)=>{ console.log(res) }) @@ -103,7 +103,7 @@ uni.offPushMessage(callback); |when |Date |否 |消息上显示的提示时间
默认为当前时间,如果延迟显示则使用延时后显示消息的时间。
Android - ALL (支持)
iOS - 5.0+ (不支持): 不支持设定消息的显示时间,由系统自动管理消息的创建时间。 | |success |Function |否 |接口调用成功的回调函数 | |fail |Function |否 |接口调用失败的回调函数 | -|complete |Function |否 |接口调用结束的回调函数(调用成功、失败都会执行) +|complete |Function |否 |接口调用结束的回调函数(调用成功、失败都会执行) **其他相关资源** @@ -132,4 +132,4 @@ QQ小程序订阅消息文档:[https://q.qq.com/wiki/develop/miniprogram/frame 华为快应用推送文档:[https://developer.huawei.com/consumer/cn/doc/development/quickApp-References/webview-api-hwpush](https://developer.huawei.com/consumer/cn/doc/development/quickApp-References/webview-api-hwpush) -## 服务端API [详情参考](/uniCloud/uni-cloud-push/api) +## 服务端API [详情参考](https://doc.dcloud.net.cn/uniCloud/uni-cloud-push/api) diff --git a/docs/api/system/authentication.md b/docs/api/system/authentication.md index d149338afafaf9597d3e75b135c75f17fec99ecd..c01a64a2e6861a0c7ace9e9354667933e2510170 100644 --- a/docs/api/system/authentication.md +++ b/docs/api/system/authentication.md @@ -2,7 +2,7 @@ 生物认证,包含手机的指纹识别、faceid两部分。即通过人体身体特征来进行身份认证识别。 -如需要专业的活体检测、人脸识别、金融级实人认证,需另见文档[uni实人认证](/uniCloud/frv/intro.md) +如需要专业的活体检测、人脸识别、金融级实人认证,需另见文档[uni实人认证](https://doc.dcloud.net.cn/uniCloud/frv/intro.html) ### uni.startSoterAuthentication(OBJECT) @@ -35,7 +35,7 @@ 注意: - App端指纹识别,Android平台从Android6.0起才提供了官方API,uni-app也是从Android6起支持。对于更低版本的安卓,某些rom私有的指纹识别API,uni-app并不支持。 -- App端人脸识别,iOS平台使用自带的faceID。Android平台需另行使用uni实人认证,另见[https://uniapp.dcloud.net.cn/uniCloud/frv/intro.html](/uniCloud/frv/intro.md) +- App端人脸识别,iOS平台使用自带的faceID。Android平台需另行使用uni实人认证,另见[https://uniapp.dcloud.net.cn/uniCloud/frv/intro.html](https://doc.dcloud.net.cn/uniCloud/frv/intro.html) **OBJECT.success返回值说明** diff --git a/docs/api/uniCloud.md b/docs/api/uniCloud.md index cebee2dfa18dc1820b7f25db916c6d07a769ca8c..b1d3f02808eabac67522a4f2176425eed608e193 100644 --- a/docs/api/uniCloud.md +++ b/docs/api/uniCloud.md @@ -1,6 +1,6 @@ -### uniCloud +### uniCloud -完整uniCloud客户端api列表请参考:[uniCloud客户端sdk](uniCloud/client-sdk.md) +完整uniCloud客户端api列表请参考:[uniCloud客户端sdk](https://doc.dcloud.net.cn/uniCloud/client-sdk.html) diff --git a/docs/collocation/pages.md b/docs/collocation/pages.md index 0965507f7c10d7f31c8ad1580fdb90c1a059878f..621ca15b0527f178f90aad5df85f547fe2826c42 100644 --- a/docs/collocation/pages.md +++ b/docs/collocation/pages.md @@ -18,7 +18,7 @@ |[leftWindow](/collocation/pages?id=leftwindow)|Object|否|大屏左侧窗口|H5| |[topWindow](/collocation/pages?id=topwindow)|Object|否|大屏顶部窗口|H5| |[rightWindow](/collocation/pages?id=rightwindow)|Object|否|大屏右侧窗口|H5| -|[uniIdRouter](/uniCloud/uni-id/summary.md#uni-id-router)|Object|否|自动跳转相关配置,新增于HBuilderX 3.5.0|uni-app x 不支持| +|[uniIdRouter](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html#uni-id-router)|Object|否|自动跳转相关配置,新增于HBuilderX 3.5.0|uni-app x 不支持| |entryPagePath|String|否|默认启动首页,新增于HBuilderX 3.7.0|微信小程序、支付宝小程序| 以下是一个包含了所有配置选项的 `pages.json` : @@ -929,7 +929,7 @@ h5 平台下拉刷新动画,只有 circle 类型。
 	
-┌─components            
+┌─components
 │  └─comp-a
 │    └─comp-a.vue      符合easycom规范的组件
 └─uni_modules          [uni_module](/uni_modules)中符合easycom规范的组件
@@ -977,7 +977,7 @@ h5 平台下拉刷新动画,只有 circle 类型。
 - 考虑到编译速度,直接在`pages.json`内修改`easycom`不会触发重新编译,需要改动页面内容触发。
 - `easycom`只处理vue组件,不处理小程序专用组件(如微信的wxml格式组件)。不处理后缀为.nvue的组件。因为nvue页面引入的组件也是.vue组件。可以参考uni ui,使用vue后缀,同时兼容nvue页面。
 - `nvue`页面里引用`.vue`后缀的组件,会按照nvue方式使用原生渲染,其中不支持的css会被忽略掉。这种情况同样支持`easycom`。
-- `vue` 与 `uvue` 组件优先级,[详见](/uni-app-x/component/README.md#priority)。
+- `vue` 与 `uvue` 组件优先级,[详见](https://doc.dcloud.net.cn/uni-app-x/component/README.html#priority)。
 
 ### Bug & Tips@easycom_tips
 + HBuilderX 3.96 版本以下`uni-app x`项目,当页面文件名与`easycom`的组件名一样时,会渲染异常,可以通过调整页面文件名规避该Bug。
diff --git a/docs/component/README.md b/docs/component/README.md
index ad0eaa259c651946aad4e164f93a064876664b9b..fd4b3ad6363d5d726116bdaef22f81264cd17239 100644
--- a/docs/component/README.md
+++ b/docs/component/README.md
@@ -257,7 +257,7 @@ uni-app为开发者提供了一系列基础组件,类似HTML里的基础标签
 
 |组件名|说明|
 |:-|:-|
-|[unicloud-db组件](/uniCloud/unicloud-db)|uniCloud数据库访问和操作组件|
+|[unicloud-db组件](https://doc.dcloud.net.cn/uniCloud/unicloud-db)|uniCloud数据库访问和操作组件|
 
 **各平台专有组件**
 
@@ -311,7 +311,7 @@ uni-app支持的组件分为vue组件和小程序自定义组件。
 
 传统vue组件,需要安装、引用、注册,三个步骤后才能使用组件。`easycom`将其精简为一步。
 
-只要组件安装在项目的components目录下或`uni_modules`目录下,并符合`components/组件名称/组件名称.(vue|uvue)`目录结构(注意:当同时存在vue和uvue时,uni-app 项目优先使用 vue 文件,而uni-app x 项目优先使用 uvue 文件,[详情](/uni-app-x/component/#%E5%A6%82%E4%BD%95%E5%BC%80%E5%8F%91%E5%90%8C%E6%97%B6%E5%85%BC%E5%AE%B9-uni-app-x-%E5%92%8C-uni-app-%E7%9A%84%E7%BB%84%E4%BB%B6))。就可以不用引用、注册,直接在页面中使用。
+只要组件安装在项目的components目录下或`uni_modules`目录下,并符合`components/组件名称/组件名称.(vue|uvue)`目录结构(注意:当同时存在vue和uvue时,uni-app 项目优先使用 vue 文件,而uni-app x 项目优先使用 uvue 文件,[详情](https://doc.dcloud.net.cn/uni-app-x/component/#%E5%A6%82%E4%BD%95%E5%BC%80%E5%8F%91%E5%90%8C%E6%97%B6%E5%85%BC%E5%AE%B9-uni-app-x-%E5%92%8C-uni-app-%E7%9A%84%E7%BB%84%E4%BB%B6))。就可以不用引用、注册,直接在页面中使用。
 
 比如前述举例的[uni-rate组件](https://ext.dcloud.net.cn/plugin?id=33),它导入到uni-app项目后,存放在了目录/components/uni-rate/uni-rate.vue
 
@@ -328,7 +328,7 @@ uni-app支持的组件分为vue组件和小程序自定义组件。
 	export default {
 		data() {
 			return {
-				
+
 			}
 		}
 	}
@@ -385,7 +385,7 @@ uni-app的基础组件中,有一个特殊基础组件是:``组
 
 它可以在前端直接获取和操作uniCloud的云端数据库。
 
-相关文档详见:[unicloud-db组件](/uniCloud/unicloud-db)
+相关文档详见:[unicloud-db组件](https://doc.dcloud.net.cn/uniCloud/unicloud-db)
 
 除了内置的数据库组件,在uni-ui扩展库里还有uniCloud的文件选择和上传组件,参考:[uni-file-picker](https://ext.dcloud.net.cn/plugin?id=4079)
 
diff --git a/docs/component/_sidebar.md b/docs/component/_sidebar.md
index bf7e345632eb764f74f850bbaf2b45e5544591a4..1c94d8505698eaa4053e88398b6c9db9ec210cb2 100644
--- a/docs/component/_sidebar.md
+++ b/docs/component/_sidebar.md
@@ -56,7 +56,7 @@
       * [微信小程序](component/ad-weixin.md)
       * [微信小程序格子广告](component/ad-grid.md)
       * [广告错误码](component/ad-error-code.md)
-    * [uniCloud-db云数据库](/uniCloud/unicloud-db.md)
+    * [uniCloud-db云数据库](https://doc.dcloud.net.cn/uniCloud/unicloud-db.html)
     * [页面属性配置节点](component/page-meta.md)
       * [page-meta](component/page-meta.md)
       * [navigation-bar](component/navigation-bar.md)
diff --git a/docs/component/ad-error-code.md b/docs/component/ad-error-code.md
index 796a5702d9b03f9d90cca94d2d3724be99376d2f..8642cdb5e1cfc8448bb224f217c328ee237f07f2 100644
--- a/docs/component/ad-error-code.md
+++ b/docs/component/ad-error-code.md
@@ -34,7 +34,7 @@ code|message|
 4. 激励视频因为有奖励,很容易招惹灰黑产,为防止被刷,推荐使用:
   - 1) 开通激励视频的服务器回调 [详情](ad-rewarded-video.md#callback)
   - 2) 不使用短信验证码等不安全登录手段,改为[App一键登陆](../univerify.md)、uni金融级实人认证(含活体检测)等更安全的身份校验
-  - 3) 使用uni云端一体安全网络,防止伪造客户端 [详情](../uniCloud/secure-network.md)
+  - 3) 使用uni云端一体安全网络,防止伪造客户端 [详情](https://uniapp.dcloud.net.cn/uniCloud/secure-network.md)
 
 #### 不治本的绕过型方案
 
diff --git a/docs/component/datacom.md b/docs/component/datacom.md
index 81d25046981d38ab2f5eec0f916308e36bdbe177..376f8762e2304520bd1b1ca19c3ff393b5f842fb 100644
--- a/docs/component/datacom.md
+++ b/docs/component/datacom.md
@@ -269,7 +269,7 @@ localdata的示例上文已经举例,下面来看下直接指定uniCloud云数
 	  export default {
 		data() {
 		  return {
-			
+
 		  };
 		},
 	  };
@@ -354,7 +354,7 @@ datacom组件规范还要求支持绑定 value,且支持双向绑定,即:
 
 ### 使用mixinDatacom快速开发datacom@mixindatacom
 
-> 版本要求:HBuilderX 3.1.0+ 
+> 版本要求:HBuilderX 3.1.0+
 
 开发一个支持localdata的datacom组件相对容易,但要开发支持云端数据的datacom组件,实现对collection、field、where等属性的解析,工作量还是不小的。
 
@@ -371,7 +371,7 @@ mixin是vue的技术,不熟悉的可以点此了解[vue官网的mixin文档](h
 |属性名						| 类型			| 	默认值		| 说明|
 |:-:						| :-:			| :-:			| :-:	|
 |localdata					|Array			|				|本地数据,[详情](https://uniapp.dcloud.net.cn/component/datacom)|
-|spaceInfo					|Object     |				|服务空间信息,新增于`HBuilderX 3.2.11`。同uniCloud.init参数,参考:[uniCloud.init](uniCloud/init.md?id=init-unicloud)|
+|spaceInfo					|Object     |				|服务空间信息,新增于`HBuilderX 3.2.11`。同uniCloud.init参数,参考:[uniCloud.init](https://doc.dcloud.net.cn/uniCloud/init.html?id=init-unicloud)|
 |collection					|String			|				|表名。支持输入多个表名,用 `,` 分割|
 |field						|String			|				|查询字段,多个字段用 `,` 分割|
 |where						|String			|				|查询条件,内容较多,另见jql文档:[详情](https://uniapp.dcloud.net.cn/uniCloud/uni-clientDB?id=jsquery)|
@@ -388,7 +388,7 @@ mixin是vue的技术,不熟悉的可以点此了解[vue官网的mixin文档](h
 |gettree					|Boolean		|	false		|是否查询树状数据,默认 `false`|
 |startwith					|String			|	''			|`gettree`的第一层级条件,此初始条件可以省略,不传startWith时默认从最顶级开始查询|
 |limitlevel					|Number			|	10			|`gettree`查询返回的树的最大层级。超过设定层级的节点不会返回。默认10级,最大15,最小1|
-|foreign-key				|String			|	''			|手动指定使用的关联关系,HBuilderX 3.1.10+ [详情](/uniCloud/clientdb?id=lookup-foreign-key)|
+|foreign-key				|String			|	''			|手动指定使用的关联关系,HBuilderX 3.1.10+ [详情](https://doc.dcloud.net.cn/uniCloud/clientdb?id=lookup-foreign-key)|
 
 
 `uniCloud.mixinDatacom` 的data
@@ -479,7 +479,7 @@ mixin是vue的技术,不熟悉的可以点此了解[vue官网的mixin文档](h
 ```
 
 
-- 方法2,使用 `mixinDatacomGet()` 
+- 方法2,使用 `mixinDatacomGet()`
 
 需要多写些代码处理各种状态。如果`mixinDatacomEasyGet`的封装无法灵活满足你的需求,可以使用这种方式。
 
diff --git a/docs/quickstart-hx.md b/docs/quickstart-hx.md
index 48d51a17d8d9df061ec35053a8e3d0734cdc3463..a04a08e424a303e56c2c1e658384578b9f1dfcc1 100644
--- a/docs/quickstart-hx.md
+++ b/docs/quickstart-hx.md
@@ -44,16 +44,16 @@ uni-app自带的模板有 默认的空项目模板、Hello uni-app 官方组件
 	
- + - 如手机或模拟器无法识别,请点击[常见故障排查指南](https://uniapp.dcloud.net.cn/tutorial/run/run-app-faq.html)。 - 如需运行在苹果手机真机上,注意需使用自定义基座。[详见](https://uniapp.dcloud.net.cn/tutorial/run/run-app.html#customplayground) - + 3. 在微信开发者工具里运行:进入hello-uniapp项目,点击工具栏的运行 -> 运行到小程序模拟器 -> 微信开发者工具,即可在微信开发者工具里面体验uni-app。
- + **注意**:如果是第一次使用,需要先配置小程序ide的相关路径,才能运行成功。如下图,需在输入框输入微信开发者工具的安装路径。
@@ -61,7 +61,7 @@ uni-app自带的模板有 默认的空项目模板、Hello uni-app 官方组件
**注意**:微信开发者工具需要开启服务端口 在微信工具的设置->安全中。 - + 4. 在支付宝小程序开发者工具里运行:进入hello-uniapp项目,点击工具栏的运行 -> 运行到小程序模拟器 -> 支付宝小程序开发者工具,即可在支付宝小程序开发者工具里面体验uni-app。
@@ -129,7 +129,7 @@ iOS App打包需要向Apple申请证书。 **注意** - `history` 模式发行需要后台配置支持,详见:[history 模式的后端配置](https://router.vuejs.org/zh/guide/essentials/history-mode.html#%E5%90%8E%E7%AB%AF%E9%85%8D%E7%BD%AE%E4%BE%8B%E5%AD%90) -- 打包后,推荐使用[前端网页托管服务](/uniCloud/hosting),一键上传,自带CDN加速,无需购买虚拟机,无需安装nginx等; +- 打包后,推荐使用[前端网页托管服务](https://doc.dcloud.net.cn/uniCloud/hosting),一键上传,自带CDN加速,无需购买虚拟机,无需安装nginx等; - 若使用传统服务器部署,建议在服务器端开启 `gzip` 压缩。参考网上的分享:https://juejin.im/post/5af003286fb9a07aac24611b ### 发布为小程序 diff --git a/docs/tutorial/_sidebar.md b/docs/tutorial/_sidebar.md index 81476a97b90c04b67378af0740e0920fe669b533..fed6352a101201dbe9776255662760430f1ee422 100644 --- a/docs/tutorial/_sidebar.md +++ b/docs/tutorial/_sidebar.md @@ -26,7 +26,7 @@ * [vue2 升 3 指南](/tutorial/migration-to-vue3.md) * [ts/typescript 专题](/tutorial/typescript-subject.md) * [jsx/tsx 语法](/tutorial/syntax-jsx.md) -* [uts语法](/uni-app-x/uts/) +* [uts语法](https://doc.dcloud.net.cn/uni-app-x/uts/) * 编译器(条件编译) * [什么是编译器](/tutorial/compiler.md) * [条件编译处理多端差异](/tutorial/platform.md) @@ -36,7 +36,7 @@ * [跨域](/tutorial/CORS.md) * [宽屏适配](/tutorial/adapt.md) * [SSR 服务端渲染](/tutorial/ssr.md) - * [前端网页托管](/uniCloud/hosting.md) + * [前端网页托管](https://doc.dcloud.net.cn/uniCloud/hosting.html) * App 专题 * [nvue 原生渲染](/tutorial/nvue-outline.md) * [综述](/tutorial/nvue-outline.md) @@ -110,7 +110,7 @@ * [未同意隐私政策模式运行](/tutorial/app-disagreemode.md) * [Google Play上架](/tutorial/android-gp.md) * [App Store上架](/tutorial/ios-app-store.md) - * [App升级](/uniCloud/upgrade-center.md) + * [App升级](https://doc.dcloud.net.cn/uniCloud/upgrade-center.html) * 小程序专题 * [组件与WXS](/tutorial/miniprogram-subject.md) * [使用小程序插件](/tutorial/mp-weixin-plugin.md) @@ -141,14 +141,14 @@ * [app 加固](/tutorial/app-security.md) * [app 隐私合规检测](/tutorial/app-privacy-detect.md) * 网络安全 - * [云端一体安全网络](/uniCloud/secure-network.md) - * [传统服务器与uniCloud安全通信](/uniCloud/uni-cloud-s2s.md) + * [云端一体安全网络](https://doc.dcloud.net.cn/uniCloud/secure-network.html) + * [传统服务器与uniCloud安全通信](https://doc.dcloud.net.cn/uniCloud/uni-cloud-s2s.html) * 身份安全 * [app一键登录](/univerify.html) - * [app实人认证](/uniCloud/frv/intro.html) - * [图形验证码](/uniCloud/uni-captcha.html) + * [app实人认证](https://doc.dcloud.net.cn/uniCloud/frv/intro.html) + * [图形验证码](https://doc.dcloud.net.cn/uniCloud/uni-captcha.html) * 服务器安全 - * [uniCloud ip防刷](/uniCloud/ip-filter.html) + * [uniCloud ip防刷](https://doc.dcloud.net.cn/uniCloud/ip-filter.html) * [内容安全审查](https://ext.dcloud.net.cn/plugin?id=5460) * [国际化专题](/tutorial/i18n.md) * [国际化开发指南](/tutorial/i18n.md) diff --git a/docs/tutorial/app-sec-api.md b/docs/tutorial/app-sec-api.md index e973bc16b2d7954a4173c7995d0299b603a3cd69..83606346b4e15a61c4fcfc86f88f82851a472763 100644 --- a/docs/tutorial/app-sec-api.md +++ b/docs/tutorial/app-sec-api.md @@ -3,10 +3,10 @@ uni-app和5+App提供了一批API,获取客户端一些与安全有关的信息。 ::: warning -更推荐使用[uni云端一体安全网络](/uniCloud/secure-network.md),使用安全网络后将无需在使用本章节提供的API。 +更推荐使用[uni云端一体安全网络](https://doc.dcloud.net.cn/uniCloud/secure-network.html),使用安全网络后将无需在使用本章节提供的API。 ::: -### getSignature +### getSignature [plus.navigator.getSignature](https://www.html5plus.org/doc/zh_cn/navigator.html#plus.navigator.getSignature)用于获取应用签名标识,可以判断App是否被重新签名。 签名证书是对App开发者身份的唯一标识,如果程序未对签名证书进行校验,可能被反编译后进行二次打包使用其它签名证书重新签名。如重新签名的App可以正常启动,则可能导致App被仿冒盗版,影响其合法收入,甚至可能被添加钓鱼代码、病毒代码、恶意代码,导致用户敏感信息泄露或者恶意攻击。 @@ -44,7 +44,7 @@ uni-app项目可以在App.vue的应用生命周期[onLaunch](https://uniapp.dclo > 提示:为了防止js检验代码被反编译篡改,建议将签名校验代码放到独立js文件中并配置[js/nvue文件原生混淆加密](app-sec-confusion),或者使用apk加固处理 -### isSimulator +### isSimulator [plus.navigator.isSimulator](https://www.html5plus.org/doc/zh_cn/navigator.html#plus.navigator.isSimulator)用于判断当前应用是否运行在模拟器中。 iOS系统由于苹果限制了正式打包后不能在模拟器上运行,一般不存在这种情况;Android系统是开源的,底层代码都是公开的,因此市面上有很多Android模拟器,此问题比较严重。 @@ -56,7 +56,7 @@ iOS系统由于苹果限制了正式打包后不能在模拟器上运行,一 onLaunch: function(inf) { console.log('App Launch'); // #ifdef APP-PLUS - // 模拟器检验 + // 模拟器检验 if(plus.navigator.isSimulator()){ //弹出提示框 uni.showModal({ @@ -76,7 +76,7 @@ iOS系统由于苹果限制了正式打包后不能在模拟器上运行,一 > 提示:为了防止js检验代码被反编译篡改,建议将签名校验代码放到独立js文件中并配置[js/nvue文件原生混淆加密](app-sec-confusion),或者使用apk加固处理 -### isSetProxy +### isSetProxy [plus.networkinfo.isSetProxy](https://www.html5plus.org/doc/zh_cn/device.html#plus.networkinfo.isSetProxy)用于判断当前应用网络环境是否设置代理。 设置代理后所有网络传输的数据都会经过代理服务器,也就是说代理服务器可能看到所有传入内容,导致用户敏感信息泄露、业务服务器被恶意攻击等问题。当然在某些企业内部网络环境为了保证安全,访问公网可能需要设置代理,开发者需要考虑这种需求来决定是否限制应用正常运行。 @@ -102,7 +102,7 @@ iOS系统由于苹果限制了正式打包后不能在模拟器上运行,一 ### isRoot [plus.navigator.isRoot](https://www.html5plus.org/doc/zh_cn/navigator.html#plus.navigator.isRoot)用于判断当前应用运行的设备是否被root破解。 -> 注: 仅iOS平台支持,Android平台暂不支持 +> 注: 仅iOS平台支持,Android平台暂不支持 root破解(也叫越狱)是利用iOS系统的漏洞来破解系统安全机制,让任何应用可以获得系统级权限,从而对系统可以进行更灵活的自定义修改,譬如说修改字体、修改主题以及使用一些插件等。iOS系统设计了沙盒机制,限制应用只能使用自身的数据,root破解后则应用可以读取修改其它任何应用的数据,可能导致用户敏感信息泄露,甚至修改其它应用的数据或代码,恶意攻击正常App。 @@ -112,7 +112,7 @@ root破解(也叫越狱)是利用iOS系统的漏洞来破解系统安全机 onLaunch: function(inf) { console.log('App Launch'); // #ifdef APP-PLUS - //ROOT检验 + //ROOT检验 if(plus.navigator.isRoot()){ //弹出提示框 uni.showModal({ diff --git a/docs/tutorial/safe.md b/docs/tutorial/safe.md index e6358efa3e81ffc223c0ceef3bec387982f792b1..d51972080ac1f398a6c1990e0adf57da19464eb4 100644 --- a/docs/tutorial/safe.md +++ b/docs/tutorial/safe.md @@ -61,13 +61,13 @@ uni安全网络需要开发者在uniCloud上开通,但并不收费。 如此高安全的保障,在商业项目中都需要花掉不少银子来采购。但DCloud**免费**给uniCloud开发者提供。 -uni云端一体安全网络文档:[详见](/uniCloud/secure-network.md) +uni云端一体安全网络文档:[详见](https://doc.dcloud.net.cn/uniCloud/secure-network.html) ## 人机验证 还有一类攻击,攻击者没有破解掉客户端和网络协议,但是用一排排手机墙。 -这时,您就需要uni的[一键登录](/univerify.md)和[实人认证](/uniCloud/frv/intro.md)。 +这时,您就需要uni的[一键登录](/univerify.md)和[实人认证](https://doc.dcloud.net.cn/uniCloud/frv/intro.html)。 `一键登录`是运营商提供的安全方案,它要求手机中必须插sim卡,并且从sim中精准读取手机号,防止手机短信验证码被打码池伪造返回。 @@ -87,13 +87,13 @@ uni的`一键登录`和`实人认证`不但和uni产品完美结合、快捷开 - 一键登录仅需0.02元/次,比发短信验证码都便宜。 -- 实人认证是阶梯价格,[详见](/uniCloud/frv/price.md) +- 实人认证是阶梯价格,[详见](https://doc.dcloud.net.cn/uniCloud/frv/price.html) 这些价格都极具优势。如果您有非常大的量,还可以再联系bd@dcloud.io沟通。 -不管是一键登录还是实人认证,在[uni-id](/uniCloud/uni-id/summary.md)里都已经内置集成好。 +不管是一键登录还是实人认证,在[uni-id](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html)里都已经内置集成好。 -无需自己写代码。账户的注册、实人认证,这些代码都已经写好并开源在[uni-id-pages](/uniCloud/uni-id-pages.md)项目中。 +无需自己写代码。账户的注册、实人认证,这些代码都已经写好并开源在[uni-id-pages](https://doc.dcloud.net.cn/uniCloud/uni-id-pages.html)项目中。 但是注意 ::: warning @@ -101,7 +101,7 @@ uni的`一键登录`和`实人认证`不但和uni产品完美结合、快捷开 因为这些认证都是收费的,如果没有安全防护,攻击者可以刷你的服务器接口,盗用你的余额来给他提供认证服务,或者干脆就是刷的让你破财。 ::: -在人机验证领域,uni还提供了免费的[图形验证码](/uniCloud/uni-captcha.md)。 +在人机验证领域,uni还提供了免费的[图形验证码](https://doc.dcloud.net.cn/uniCloud/uni-captcha.html)。 ## 服务器安全 @@ -111,7 +111,7 @@ uni的`一键登录`和`实人认证`不但和uni产品完美结合、快捷开 如果让攻击者攻击整个阿里云或腾讯云的serverless资源池,那这个池子太大了,那些攻击者根本无法打垮uniCloud服务。 -uniCloud还提供了[ip防刷](/uniCloud/ip-filter.md)功能,可以在uniCloud web控制台设置,拉黑某些ip,或者自动屏蔽指定时间内访问次数过高的ip。 +uniCloud还提供了[ip防刷](https://doc.dcloud.net.cn/uniCloud/ip-filter.html)功能,可以在uniCloud web控制台设置,拉黑某些ip,或者自动屏蔽指定时间内访问次数过高的ip。 如果您的应用涉及用户提交内容,那么有一个很大的风险就是用户提交非法内容,导致您的应用被公安或运营商禁封。 diff --git a/docs/uni-ad/ad-rewarded-video.md b/docs/uni-ad/ad-rewarded-video.md index ebf974dd1fcb9eb25f7aa7490190bcf9cfe48e45..9299fbe65bcf9ad29492bbe4b9ee81ae5dd2dd3d 100644 --- a/docs/uni-ad/ad-rewarded-video.md +++ b/docs/uni-ad/ad-rewarded-video.md @@ -619,14 +619,14 @@ sign = sha256(secret:transid) ### 微信小程序说明@callbackweixin -3.6.8+ 支持微信小程序服务器回调,目前仅支持使用 [uni-id](/uniCloud/uni-id/summary.html) 用户体系的小程序,后续支持非 uni-id 用户系统 +3.6.8+ 支持微信小程序服务器回调,目前仅支持使用 [uni-id](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html) 用户体系的小程序,后续支持非 uni-id 用户系统 #### 接入流程 -1. 项目使用了 [uni-id-co](/uniCloud/uni-id/summary.md#save-user-token) 并更新到 1.0.8+ -2. 使用 [uni-open-bridge](/uniCloud/uni-open-bridge.html) 托管三方开放平台数据 -3. 配置 [安全网络](/uniCloud/secure-network.html) +1. 项目使用了 [uni-id-co](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html#save-user-token) 并更新到 1.0.8+ +2. 使用 [uni-open-bridge](https://doc.dcloud.net.cn/uniCloud/uni-open-bridge.html) 托管三方开放平台数据 +3. 配置 [安全网络](https://doc.dcloud.net.cn/uniCloud/secure-network.html) #### 安全注意 @@ -636,7 +636,7 @@ sign = sha256(secret:transid) 为了提升安全性,建议所有使用激励视频的开发者都要做如下工作来加强保护: 1. 前端代码加密。涉及激励相关的,在manifest中配置好要加密的代码文件,打包后会自动加密相应文件。[详见](https://ask.dcloud.net.cn/article/36437) 2. apk加固。即便前端代码加密,原生层引擎的java代码仍然可能被反编译,需要对apk加固。市面上很多加固服务,比如360加固、爱加密加固均可以自行选择。 -3. 使用uni云端一体安全网络,防止伪造客户端攻击。[详见](/uniCloud/secure-network.md) +3. 使用uni云端一体安全网络,防止伪造客户端攻击。[详见](https://doc.dcloud.net.cn/uniCloud/secure-network.html) 3. 使用如下安全类API,防止客户端被篡改 - plus.navigator.getSignature 获取应用签名标识。结合在服务器端存放证书信息,可比对判断App的证书是否被重签 [规范](https://www.html5plus.org/doc/zh_cn/navigator.html#plus.navigator.getSignature) - plus.navigator.isSimulator 判断App是否运行在模拟器环境 [规范](https://www.html5plus.org/doc/zh_cn/navigator.html#plus.navigator.isSimulator) diff --git a/docs/uni-app-x/_sidebar.md b/docs/uni-app-x/_sidebar.md deleted file mode 100644 index 31c94bff3c0715148a870d5860b7a2932febc1a5..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/_sidebar.md +++ /dev/null @@ -1,16 +0,0 @@ -* [概述](README.md) -* [项目](project.md) -* [页面](page.md) -* 教程 - * [与js开发的差别](tutorial/codegap.md) - * [request联网教程](tutorial/request.md) - * [复杂列表开发指南](tutorial/stickynestlist.md) - * [全局变量与状态管理](tutorial/store.md) - * [几种组件标记的概念澄清](tutorial/idref.md) -* vue 框架 - * [概述](vue/README.md) -* 运行和调试 - * [真机运行](https://uniapp.dcloud.net.cn/tutorial/run/run-app.html) - * [Android审查元素](debug/android-inspector.md) -* [性能优化](performance.md) -* [uni错误规范](https://uniapp.dcloud.net.cn/tutorial/err-spec.html) diff --git a/docs/uni-app-x/api/README.md b/docs/uni-app-x/api/README.md deleted file mode 100644 index f00b6982296df122ed6cdcf4cfbb482ce330b1ce..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/README.md +++ /dev/null @@ -1,75 +0,0 @@ -# API概述 - -uni-app x项目的uts代码中可以使用很多API。包括: - -- uts的api [详见](../../uts/buildin-object-api/global.md) -- 全局api,前面不需要加`uni.`。如`getApp` -- uni.xxx的内置api。见左侧 -- uniCloud.xxx的内置api。见左侧 -- dom的api [详见](dom/README.md) -- vue的api [详见](../../tutorial/vue3-api.md) -- 原生api - - 由于uts可以直接调用Android和iOS的api,所以os和三方sdk的能力都可以在uts中调用。如下: - -```vue - -``` - -上面的示例,在页面启动时打印了2行日志,显示手机型号。 - -- uni.getSystemInfoSync,是uni的api -- import的Build,是Android os的api - -可以看出,在uni-app x里,可以直接调用os的能力,不受限制,语法是uts的语法,但需要了解什么功能在原生里是哪个api。 - -使用`uni.getSystemInfoSync`则比较简单,看uni的文档即可,且可跨平台。 - -其实,[uni.getSystemInfoSync](https://gitcode.net/dcloud/uni-api/-/blob/master/uni_modules/uni-getSystemInfo/utssdk/app-android/index.uts) 的内部实现就是一个uts模块,底层使用了一样的代码,也是import了android.os.Build。 - -大多数uni.的api,都是uts开发的,它们会陆续开源在[uni-api](https://gitcode.net/dcloud/uni-api)。 - -插件市场也有很多做好的uts插件,方便开发者拿来即用。[uts插件](https://ext.dcloud.net.cn/?cat1=8&type=UpdatedDate) - -虽然上述页面可以直接调用原生能力,但一般原生能力建议封装为[uni_modules](../../plugin/uni_modules.md)形式的[uts插件](../../plugin/uts-plugin.md)。这样方便共享、方便跨平台。 - -uni-app x 中不再支持plus和weex的API。过于plus api中一些常用的api,在uni-app x中进行了替换增补。 -- plus.runtime.quit => [uni.exit](./exit.md) -- plus.runtime.install => [uni.installApk](./install-apk.md) -- plus.runtime.openURL - 暂未封装API,但可以直接使用如下代码调用。 -```vue - - -``` - \ No newline at end of file diff --git a/docs/uni-app-x/api/_sidebar.md b/docs/uni-app-x/api/_sidebar.md deleted file mode 100644 index 24d3fc00c55e1aa2c00e60de57c8ff21bc851717..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/_sidebar.md +++ /dev/null @@ -1,67 +0,0 @@ -* [概述](README.md) -* 全局 - * [getApp](get-app.md) - * [getCurrentPages](get-current-pages.md) -* 基础 - * [事件总线event-bus](event-bus.md) - * [拦截器](interceptor.md) - * [获取启动参数](get-launch-options-sync.md) - * [退出应用](exit.md) -* 页面 - * [页面跳转](navigator.md) - * [设置导航条颜色](set-navigation-bar-color.md) - * [设置导航条标题](set-navigation-bar-title.md) - * [设置tabbar](set-tabbar.md) - * [页面下拉刷新](pull-down-refresh.md) - * [将页面滚动到指定位置](page-scroll-to.md) -* 元素节点 - * [获取element](get-element.md) - * [获取node](nodes-info.md) -* 界面 - * [交互反馈](prompt.md) - * [动态加载字体](load-font-face.md) - * [截屏事件](capturescreen.md) -* 网络 - * [发起请求request](request.md) - * [上传文件](upload-file.md) - * [下载文件](download-file.md) - * [获取设备网络状态](get-network-type.md) - * [websocket](websocket-global.md) -* 设备 - * [获取系统信息](get-system-info.md) - * [获取设备信息](get-device-info.md) - * [获取窗口信息](get-window-info.md) - * [获取app基础信息](get-app-base-info.md) - * [获取app授权设置](get-app-authorize-setting.md) - * [获取系统设置](get-system-setting.md) - * [获取电量信息](get-battery-info.md) - * [安装 APK](install-apk.md) - * [wifi](wifi.md) - * [内存](memory.md) - * [截屏事件](capturescreen.md) -* 媒体 - * [拍照和相册选择](choose-image.md) - * [图片预览](preview-image.md) - * [保存图片到相册](save-image-to-photos-album.md) -* 位置 - * [获取当前位置](get-location.md) -* 推送 - * [推送](push.md) -* 数据存储 - * [storage(key-value存储)](storage.md) - -* 登录和验证 - - * [实人认证](facial-recognition-verify.md) -* 组件上下文对象 - * [web-view组件上下文对象](create-webview-context.md) - * [video组件上下文对象](create-video-context.md) -* uniCloud客户端API - * [概述](unicloud/README.md) - * [云函数](unicloud/function.md) - * [云对象](unicloud/object.md) - * [数据库](unicloud/database.md) - * [云存储](unicloud/storage.md) - * [其他API](unicloud/utils.md) -* [未支持的API及替代方案](ext.md) \ No newline at end of file diff --git a/docs/uni-app-x/api/capturescreen.md b/docs/uni-app-x/api/capturescreen.md deleted file mode 100644 index 63c6c04c1b5c4d0777ee3919250de8cb4017d324..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/capturescreen.md +++ /dev/null @@ -1,30 +0,0 @@ -## uni.onUserCaptureScreen(callback?) @onusercapturescreen - - - - - - - - - - - -## uni.offUserCaptureScreen(callback?) @offusercapturescreen - - - - - - - - - - - - - - - -## tips -- 本文的截屏指手机自带的截屏事件的监听和取消监听,由用户操作手机按键触发。如需通过代码对view截屏,另见API [takeSnapshot](../dom/element.md#takesnapshot) \ No newline at end of file diff --git a/docs/uni-app-x/api/choose-image.md b/docs/uni-app-x/api/choose-image.md deleted file mode 100644 index cd522189127d5198a8c21edfac574a1ac764d863..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/choose-image.md +++ /dev/null @@ -1,20 +0,0 @@ -## uni.chooseImage(options) @chooseimage - - - - - - - - - - - - - - - - - -## Tips -* 获取手机端app是否拥有摄像头权限,请使用API [uni.getAppAuthorizeSetting](get-app-authorize-setting.md) \ No newline at end of file diff --git a/docs/uni-app-x/api/create-video-context.md b/docs/uni-app-x/api/create-video-context.md deleted file mode 100644 index da5011c677950f35c5ece62fda6a5d3bec9b0331..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/create-video-context.md +++ /dev/null @@ -1,17 +0,0 @@ -## uni.createVideoContext(videoId, component?) @createvideocontext - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/create-webview-context.md b/docs/uni-app-x/api/create-webview-context.md deleted file mode 100644 index 34ecc957c39099949f802f0229d1fbd50221c418..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/create-webview-context.md +++ /dev/null @@ -1,17 +0,0 @@ -## uni.createWebviewContext(webviewId, component?) @createwebviewcontext - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/download-file.md b/docs/uni-app-x/api/download-file.md deleted file mode 100644 index 557c379c2e77c829a49fdbb3f480077e75df5bb9..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/download-file.md +++ /dev/null @@ -1,23 +0,0 @@ -## uni.downloadFile(options) @downloadfile - - - - - - - - - - - - - - - - - - - -## Tips - -- 3.98以下版本,下载的文件存放在应用沙盒非cache目录,不会自动删除。3.98及以上版本迁移到应用临时目录(Android原生应用沙盒目录下的cache目录),由系统清理管理。 \ No newline at end of file diff --git a/docs/uni-app-x/api/event-bus.md b/docs/uni-app-x/api/event-bus.md deleted file mode 100644 index 8d65e8d77d950beaa9a77671c0feafecd423a99b..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/event-bus.md +++ /dev/null @@ -1,61 +0,0 @@ -## uni.$on(eventName, callback) @$on - - - - - - - - - - - - - -## uni.$off(eventName, callback) @$off - - - - - - - - - - - - - -## uni.$once(eventName, callback) @$once - - - - - - - - - - - - - -## uni.$emit(eventName, args?) @$emit - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/exit.md b/docs/uni-app-x/api/exit.md deleted file mode 100644 index 2c64c00e2df3484ae3f21b499894f5b5420e0bb7..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/exit.md +++ /dev/null @@ -1,27 +0,0 @@ -## uni.exit(options?) @exit - - - - - - - - - -本API仅Android App生效。 - -Android平台的应用退出分热退出和冷退出。 -- 冷退出是彻底杀掉 -- 热退出是关闭可见的activity,后台进程不退出(比如push) - -基本上主流Android App都是热退出。本API也是热退出。 - -热退出,即通知了os:这个app用户不用了,在os需要时可以回收。如果在os回收之前,用户又启动这个app,会感觉启动速度更快一些。 - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/ext.md b/docs/uni-app-x/api/ext.md deleted file mode 100644 index 86b4d16860bc78e8d56599038f149980bff4004d..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/ext.md +++ /dev/null @@ -1,12 +0,0 @@ -# 其它api - -插件市场和hello示例中还有一批可替代uni内置api的插件或示例代码,比如: -- [剪切板](https://ext.dcloud.net.cn/search?q=%E5%89%AA%E5%88%87%E6%9D%BF&orderBy=Relevance&cat1=8&cat2=81):`uni.setClipboardData`、`uni.getClipboardData` -- [拨打电话](https://ext.dcloud.net.cn/plugin?id=15235):`uni.makePhoneCall` -- [打开三方应用](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/dev/pages/template/schema/schema.uvue):打开浏览器、应用商店、地图并传参。`plus.openUrl` -- [分享](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/dev/pages/template/share/share.uvue):`uni.shareWithSystem` -- 打开文件:`uni.openDocument`。[hello uts示例](](https://gitcode.net/dcloud/hello-uts/-/blob/dev/uni_modules/uts-nativepage/utssdk/app-android/index.uts))、[插件市场](https://ext.dcloud.net.cn/plugin?id=12731) -- [扫码](https://ext.dcloud.net.cn/search?q=%E6%89%AB%E7%A0%81&cat1=8&type=UpdatedDate):`uni.scanCode` -- [文件选择](https://ext.dcloud.net.cn/search?q=%E6%96%87%E4%BB%B6%E9%80%89%E6%8B%A9&cat1=8&cat2=81):`uni.chooseFile` -- [蓝牙](https://ext.dcloud.net.cn/search?q=%E8%93%9D%E7%89%99&orderBy=Relevance&cat1=8&cat2=81) -- [nfc](https://ext.dcloud.net.cn/search?q=nfc&orderBy=Relevance&cat1=8&cat2=81) diff --git a/docs/uni-app-x/api/facial-recognition-verify.md b/docs/uni-app-x/api/facial-recognition-verify.md deleted file mode 100644 index 637f50f4bf6f7b2efc166a5eaba21e7abf3e357e..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/facial-recognition-verify.md +++ /dev/null @@ -1,40 +0,0 @@ -# uni实人认证 - -uni实人认证是DCloud与合作伙伴共同推出的金融级实人认证服务,通过对比人脸、活体检测、姓名和身份证号码,来确认用户身份的有效性。 - -该业务的完整业务介绍另见:[实人认证](https://uniapp.dcloud.net.cn/uniCloud/frv/intro.html) - -本文是 uni-app x 中涉及该业务的API的介绍。 - -## uni.getFacialRecognitionMetaInfo() @getfacialrecognitionmetainfo - - - - - - - - - - - -## uni.startFacialRecognitionVerify(faceStyle) @startfacialrecognitionverify - - - - - - - - - - - - - - - - - -## Tips -* 获取手机端app是否拥有摄像头权限,请使用API [uni.getAppAuthorizeSetting](get-app-authorize-setting.md) \ No newline at end of file diff --git a/docs/uni-app-x/api/file-system.md b/docs/uni-app-x/api/file-system.md deleted file mode 100644 index 3dca7df2fee48641c97792192906d79c05ba4eeb..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/file-system.md +++ /dev/null @@ -1,112 +0,0 @@ -# 文件系统 -文件系统提供一套跨平台操作文件的管理接口,包括文件和目录的增删改名、获取信息、读写文件等常用功能。 - -通过[uni.getFileSystemManager](filemanager.md)可以获取到文件系统管理器,所有文件系统的管理操作通过 [FileSystemManager](filemanager.md#FileSystemManager) 来调用。 -```uts -const fs = uni.getFileSystemManager() -``` - -文件主要分两大类: -- 项目包文件:指 uni-app x 项目目录中添加的文件,比如static目录下的文件。Android发行后存放在assets目录下。 -- 本地文件:指 uni-app x 应用在手机端运行时可访问的磁盘文件。又分以下目录: - + 应用沙盒目录:App平台原生应用的沙盒目录,其中包括缓存文件目录和用户文件目录 - * 缓存文件目录:App平台运行过程中框架保存缓存文件的目录 - * 用户文件目录:App平台提供给开发者操作的本地文件目录 - - -## 项目包文件 -项目包文件放置应用首次加载时需要的文件,对于内容较大或需要动态更新的文件,不推荐添加到项目包文件中,可以在应用启动后联网将文件下载到本地。 - -推荐将文件放到static目录(uni_modules下也有static目录),详情参考[工程目录结构](https://uniapp.dcloud.net.cn/tutorial/project.html#static) - -没有在static目录的静态文件(比如image src指定静态路径或import),发行后会变编译到与static同级的assets目录,其中的文件名会加入随机数以避免重名。 -因为随机数的存在,导致很难使用FileSystemManager访问。所以还是推荐使用static目录。 - -**通过FileSystemManager访问项目包文件** - -通过路径访问项目包文件需从项目根目录开始写文件路径,如:/static/uni.png、/uni_modules/xxx/static/clear.png。 - ->注意:项目包文件仅可读取和复制,无法动态修改或删除。修改项目包文件需要重新发布新版本。 - -**真机运行注意** - -App端真机运行期间会做特殊处理,将项目包文件同步到`应用沙盒目录`下的特定目录: -- Android平台 - 保存在应用专属存储空间的外置存储空间根目录下的apps目录,通常为“/sdcard/Android/data/%应用包名%/apps/%应用AppID%/www/” -- iOS平台 - 保存在应用沙盒目录下的Documents/uni-app-x目录,通常为“/%应用沙盒目录%/Documents/uni-app-x/apps/%应用AppID%/www/” - - -## 本地文件 -本地文件是指应用安装到设备(通常指手机)后,系统会提供一块独立的文件存储区域。在App端将会以应用维度隔离,即在同一台设备,不同应用间的本地文件不能直接相互访问。 - -本地文件路径格式为: -``` -{{协议名}}://文件路径 -``` -> App端,协议名为"unifile",不应该直接拼写协议名路径访问本地文件,推荐使用uni.env中的目录常量获取本地文件目录的路径。 - -本地文件沙盒目录,分内置和外置。外置可以在Android手机自带的系统文件管理器里看到,并且用户可以改动。内置的保护级别更高,无法在系统文件管理器中看到。 - -**通过uni.env的目录常量访问本地文件** - -以下示例为在`用户文件目录`下写入hello.txt文件: -```ts -const fs = uni.getFileSystemManager(); -fs.writeFile({ - filePath: `${uni.env.USER_DATA_PATH}/hello.txt`, - data: 'hello uni-app x!', - encoding: 'utf-8' -} as WriteFileOptions); -``` - - -### 外置应用沙盒目录 -目录常量名称:`uni.env.SANDBOX_PATH` - -App端专有目录,为应用沙盒根目录,其下包含了`缓存文件目录`和`用户文件目录`。此目录在不同平台差异较大,不建议直接使用此目录,需开发者根据平台特性谨慎操作。 - -实际保存的目录在不同平台存在差异: -- Android平台 - 应用专属存储空间的外置存储空间根目录,通常为“/sdcard/Android/data/%应用包名%/”,其下的cache目录为`缓存文件目录`,其下的files目录为`用户文件目录` -- iOS平台 - 应用沙盒虚拟目录,其下包括Document、Library、tmp目录,此目录只可读,不可创建其它目录 - -本目录可以在Android系统的文件管理器中看到。用户在文件管理器中可以查阅删改。手机被root后的沙盒机制也会失效,可以被其他app操作。 - -#### 缓存文件目录 -目录常量名称:`uni.env.CACHE_PATH` - -App端本地缓存文件目录保存应用运行过程中产生的缓存文件,操作系统会在存储空间不足时清除缓存文件,因此不要在此目录中保存应用的关键业务数据文件。 - -实际保存的目录在不同平台存在差异: -- Android平台 - 应用专属存储空间的外置存储空间根目录下的cache目录,通常为“/sdcard/Android/data/%应用包名%/cache/” -- iOS平台 - 应用沙盒目录下的Library/Caches目录 - -uni-app x的部分内置API会产生临时文件会放置在本cache目录,如: -- uni.downloadFile下载的文件 -- uni.uploadFile上传的文件 -- uni.chooseImage的拍照或选择的相册文件 - -- dom element的截图API - -#### 用户文件目录 -目录常量名称:`uni.env.USER_DATA_PATH ` - -App端用户文件目录提供给开发者在应用运行期保存业务逻辑文件,此目录不会被操作系统自动清除,由开发者完全自由管理。 - -实际保存的目录在不同平台存在差异: -- Android平台 - 应用专属存储空间的外置存储空间根目录下的files目录,通常为“/sdcard/Android/data/%应用包名%/files/” -- iOS平台 - 应用沙盒目录下的Document目录 - -### 内置应用沙盒目录 - -目录常量名称:`uni.env.ANDROID_INTERNAL_SANDBOX_PATH` - -uni-app x框架的一些内置组件和API会涉及缓存文件,存放到本目录,如: -- image/video组件的网络图片缓存 - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-app-authorize-setting.md b/docs/uni-app-x/api/get-app-authorize-setting.md deleted file mode 100644 index 849f5c4cf58eac8cc98ecb57a265fe84e0744d24..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-app-authorize-setting.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.getAppAuthorizeSetting() @getappauthorizesetting - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-app-base-info.md b/docs/uni-app-x/api/get-app-base-info.md deleted file mode 100644 index 6ab455be1338aaccea69132f363bf8fee012c83c..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-app-base-info.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.getAppBaseInfo(options?) @getappbaseinfo - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-app.md b/docs/uni-app-x/api/get-app.md deleted file mode 100644 index 51c4ef2f28c5fd24d2f48689eda1ed68526616a6..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-app.md +++ /dev/null @@ -1,21 +0,0 @@ -## getApp() @getapp - - - - - - - - - - - - - - - -以上示例,getApp()后调用了app.uvue里定义的increasetLifeCycleNum方法。app.uvue的源码[另见](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/App.uvue) - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-battery-info.md b/docs/uni-app-x/api/get-battery-info.md deleted file mode 100644 index a1a6d0e9f44da4f08a2edb4926e0b271ba69de11..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-battery-info.md +++ /dev/null @@ -1,33 +0,0 @@ -## uni.getBatteryInfo(options) @getbatteryinfo - - - - - - - - - - - - - -## uni.getBatteryInfoSync() @getbatteryinfosync - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-current-pages.md b/docs/uni-app-x/api/get-current-pages.md deleted file mode 100644 index 97bed6a2631ae1faf93db6b9ed058ff4fee3c244..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-current-pages.md +++ /dev/null @@ -1,19 +0,0 @@ -## getCurrentPages() @getcurrentpages - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-device-info.md b/docs/uni-app-x/api/get-device-info.md deleted file mode 100644 index 2a28195741fb6d97343d8210fb2c999bf2db80ff..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-device-info.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.getDeviceInfo(options?) @getdeviceinfo - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-element.md b/docs/uni-app-x/api/get-element.md deleted file mode 100644 index f3d45056c529ac79c82ba36c40e1be0b8387c0bd..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-element.md +++ /dev/null @@ -1,22 +0,0 @@ -## uni.getElementById(id) @getelementbyid - - - - - -`3.93+` 支持泛型,可通过 `uni.getElementById(id)` 获取指定类型的元素。对于组件有自带方法的情况,通过泛型指定具体的元素类型,就可以调用该类型组件的专用方法,比如unicloud-db组件。\ -具体的组件元素类型,可查阅`组件文档/组件类型`获取。 - - - - - - - - - - - - - - diff --git a/docs/uni-app-x/api/get-file-system-manager.md b/docs/uni-app-x/api/get-file-system-manager.md deleted file mode 100644 index 9e1e368b1a5f8745829d7fa7a87c6cfeb67b7a4a..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-file-system-manager.md +++ /dev/null @@ -1,21 +0,0 @@ -## uni.getFileSystemManager() @getfilesystemmanager - - - -文件管理器对象,用于操作应用可访问的本地文件空间,在app-Android上是沙盒目录。 - -可实现目录和文件的创建、删除、改名或改路径、遍历目录、获取文件信息、读写文件。 - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-launch-options-sync.md b/docs/uni-app-x/api/get-launch-options-sync.md deleted file mode 100644 index d4b04bcf820269cd61fefecb785c77575aac9814..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-launch-options-sync.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.getLaunchOptionsSync() @getlaunchoptionssync - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-location.md b/docs/uni-app-x/api/get-location.md deleted file mode 100644 index 5c003eb9b093e78d9bf4b45f7fe49f7c8800706d..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-location.md +++ /dev/null @@ -1,39 +0,0 @@ -## uni.getLocation(options) @getlocation - - - - - - - - - -### 注意 - -uni-app x的定位,默认是系统定位,system。 - -system的定位仅支持wgs84坐标系、不支持逆地址解析、且某些老型号国产Android机因gms问题不支持系统定位、国产Rom可能不支持高度信息。 - -如需更强的定位能力,需加载专业定位sdk。 - -真机运行基座不包含三方定位sdk。 - -三方定位sdk方面,暂不支持高德、百度,但支持腾讯定位。 - -可下载[腾讯定位插件](https://ext.dcloud.net.cn/plugin?id=14569),在插件中配置key打包后生效。 - -上述腾讯定位插件属于[ext api插件](../../api/extapi.md),引用到工程后,会覆盖uni.getLocation的实现,替换掉系统定位。 - -如需其他定位,请在插件市场搜索定位相关的uts插件。 - -获取手机端app是否拥有定位权限,请使用API [uni.getAppAuthorizeSetting](get-app-authorize-setting.md) - -不管系统定位、还是三方sdk定位,都有很多注意事项,包括gms、坐标系、隐私和权限等,请仔细阅读下面的参考链接。 - - - - - - - - diff --git a/docs/uni-app-x/api/get-network-type.md b/docs/uni-app-x/api/get-network-type.md deleted file mode 100644 index 21bcb6af4fe703c27c8beb9a16d2ff36da258ec2..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-network-type.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.getNetworkType(options) @getnetworktype - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-system-info.md b/docs/uni-app-x/api/get-system-info.md deleted file mode 100644 index b23ad0e0737cf927655b909537d86b29f64d6d0e..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-system-info.md +++ /dev/null @@ -1,45 +0,0 @@ -## uni.getSystemInfo(options) @getsysteminfo - - - -uni-app 提供了异步(`uni.getSystemInfo`)和同步(`uni.getSystemInfoSync`)的2个API获取系统信息。 - -按照运行环境层级排序,从底层向上,systemInfo有6个概念: -- `device`:运行应用的设备,如iphone、huawei -- `os`:设备的操作系统,如 ios、andriod、windows、mac、linux -- `rom`:基于操作系统的定制,Android系统特有概念,如miui、鸿蒙 -- `host`:运行应用的宿主程序,即OS和应用之间的运行环境,如浏览器、微信等小程序宿主、集成uniMPSDK的App。uni-app直接开发的app没有host概念 -- `uni`:uni-app框架相关的信息,如uni-app框架的编译器版本、运行时版本 -- `app`:开发者的应用相关的信息,如应用名称、版本 - -[详见](https://uniapp.dcloud.net.cn/api/system/info.html#getsysteminfo) - - - - - - - - - - - -## uni.getSystemInfoSync() @getsysteminfosync - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-system-setting.md b/docs/uni-app-x/api/get-system-setting.md deleted file mode 100644 index cf1abec9ff21195f314a810924f32bcc7cd8bd04..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-system-setting.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.getSystemSetting() @getsystemsetting - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-univerify-manager.md b/docs/uni-app-x/api/get-univerify-manager.md deleted file mode 100644 index 998cefb5aa52fd90c29d9ceecd51bd58f1d0396d..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-univerify-manager.md +++ /dev/null @@ -1,30 +0,0 @@ -## uni.getUniverifyManager() @getuniverifymanager - - - -App一键登陆,封装了个推的一键登陆sdk,其内部再次封装了中国三大电信运营商提供的sdk。通过运营商提供的服务,可以在手机sim卡信号正常的情况下,通过云端接口获取到当前用户的手机号。 - -App一键登陆是替代短信验证码登录的更优选择:对开发者而言更便宜、对用户而言体验更好。 - -一键登陆涉及业务开通和付费,涉及客户端和服务器交互,有较多文档: -1. 业务介绍:介绍业务流程、开通和付费。[详见](https://uniapp.dcloud.net.cn/univerify.html) -2. 客户端API,即本文 -3. 服务器API,[详见](https://uniapp.dcloud.net.cn/uniCloud/uni-login/dev.html) - - - - - - - - - - - -## Tips -- 运营商对一键登陆给用户呈现的ui有强制要求。(需补充细节) -- 目前一键登陆的UI可自定义性有限。仅支持配置登录页全屏/半屏、登录页背景色、登录按钮文案以及登录页logo。 - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/get-window-info.md b/docs/uni-app-x/api/get-window-info.md deleted file mode 100644 index f79fe2b1cf0be11ff9747368db6f7e5eb974bba3..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/get-window-info.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.getWindowInfo() @getwindowinfo - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/install-apk.md b/docs/uni-app-x/api/install-apk.md deleted file mode 100644 index 5592f4d4e18479c8d3973f65748abff867646bad..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/install-apk.md +++ /dev/null @@ -1,17 +0,0 @@ -## uni.installApk(options) @installapk - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/interceptor.md b/docs/uni-app-x/api/interceptor.md deleted file mode 100644 index 8157b7fa928ddd80b54e6ac568c769496a272284..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/interceptor.md +++ /dev/null @@ -1,34 +0,0 @@ -## uni.addInterceptor(name, interceptor) @addinterceptor - - - - - - - - - - - -## uni.removeInterceptor(name, interceptor?) @removeinterceptor - - - - - - - - - - - - - - - - - -## Tips@tips - -* 目前仅以下接口支持拦截器:navigateTo、redirectTo、reLaunch、switchTab、navigateBack、loadFontFace、pageScrollTo、startPullDownRefresh、setNavigationBarColor、setNavigationBarTitle、setTabBarBadge、removeTabBarBadge、setTabBarItem、setTabBarStyle、hideTabBar、showTabBar、showTabBarRedDot、hideTabBarRedDot -* 如需拦截request,可在插件市场搜索[拦截器插件](https://ext.dcloud.net.cn/search?q=%E6%8B%A6%E6%88%AA%E5%99%A8&uni-appx=1) \ No newline at end of file diff --git a/docs/uni-app-x/api/load-font-face.md b/docs/uni-app-x/api/load-font-face.md deleted file mode 100644 index 81f7f87e989d8072f8ed443d112add54d239fb92..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/load-font-face.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.loadFontFace(options) @loadfontface - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/memory.md b/docs/uni-app-x/api/memory.md deleted file mode 100644 index 071ce2a6e93b014402efd4d5e5fab19bd97e7c4c..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/memory.md +++ /dev/null @@ -1,27 +0,0 @@ -## uni.onMemoryWarning(UTSCallback) @onmemorywarning - - - - - - - - - - - -## uni.offMemoryWarning(callback?) @offmemorywarning - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/navigator.md b/docs/uni-app-x/api/navigator.md deleted file mode 100644 index 1bd2a53349ffa293cdb984f84d2c012819c6e8b9..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/navigator.md +++ /dev/null @@ -1,83 +0,0 @@ -## uni.navigateTo(options) @navigateto - - - - - - - - - - - - - -## uni.redirectTo(options) @redirectto - - - - - - - - - - - - - -## uni.reLaunch(options) @relaunch - - - - - - - - - - - - - -## uni.switchTab(options) @switchtab - - - - - - - - - - - - - -## uni.navigateBack(options?) @navigateback - - - - - - - - - - - - - - - - - - - -## Bug & Tips@tips - -* ``navigateTo``, ``redirectTo`` 只能打开非 tabBar 页面。 -* ``switchTab`` 只能打开 ``tabBar`` 页面。 -* ``reLaunch`` 可以打开任意页面。 -* 页面底部的 ``tabBar`` 由页面决定,即只要是定义为 ``tabBar`` 的页面,底部都有 ``tabBar``。 -* 不能在首页 ```onReady``` 之前进行页面跳转。 \ No newline at end of file diff --git a/docs/uni-app-x/api/nodes-info.md b/docs/uni-app-x/api/nodes-info.md deleted file mode 100644 index 3ebba9cf7f62b5741066f49ce9d55c3a02966dba..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/nodes-info.md +++ /dev/null @@ -1,102 +0,0 @@ -## uni.createSelectorQuery() @createselectorquery - - - - - -**selector 说明:** - -``selector`` 类似于 CSS 的选择器,但仅支持下列语法。 -- ID选择器:``#the-id`` -- class选择器:``.a-class`` - - - -##### NodeInfo 属性值 - -|属性 |类型 |说明 | -|--- |--- |--- | -|id |String |节点的 ID | -|dataset|Object |节点的 dataset | -|left |Number |节点的左边界坐标 | -|right |Number |节点的右边界坐标 | -|top |Number |节点的上边界坐标 | -|bottom |Number |节点的下边界坐标 | -|width |Number |节点的宽度 | -|height |Number |节点的高度 | - - - - - - - - - - - - -组件内使用 - -`this.createSelectorQuery()`, 等效于 `uni.createSelectorQuery().in(this)` - -```html - - - -``` - - - - - - -**exec 示例说明:** - -`exec()` 返回所有动作的集合,每一项的数据类型取决于查询动作,结果排序按照调用动作顺序 - -示例: - -```js -this.createSelectorQuery().select('.rect1').boundingClientRect().exec() -// 共返回 1 条结果,第一项数据类型为 NodeInfo -result = [ {} ] -``` - -```js -this.createSelectorQuery().selectAll('.rect1').boundingClientRect().exec() -// 共返回 1 条结果,第一项数据类型为 NodeInfo[] -result = [ [{},{}] ] -``` - -```js -this.createSelectorQuery().select('.rect1').selectAll('.rect2').boundingClientRect().exec() -// 共返回 2 条结果,第一项数据类型为 NodeInfo,第二项数据类型类型为 NodeInfo[] -result = [ {}, [{},{}] ] -``` diff --git a/docs/uni-app-x/api/page-scroll-to.md b/docs/uni-app-x/api/page-scroll-to.md deleted file mode 100644 index 3342b5163bd549898fcc3d0f5912771175b96f72..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/page-scroll-to.md +++ /dev/null @@ -1,52 +0,0 @@ -## uni.pageScrollTo(options) @pagescrollto - - - -可以滚动到指定的scrollTop值处,也可以滚动到指定的目标元素处(通过css选择器selector), 仅支持一级 class - -app-uvue下,只有页面的根元素为scroll-view时,本API才生效。[详见](../css/readme.md#pagescroll) - - - -`scrollTop` 和 `selector` 必须指定其中一个属性,否者触发 `fail` 回调 - - - - - - - - - -**selector 语法** - -selector类似于 CSS 的选择器,但仅支持下列语法。 - -- ID选择器:#the-id -- class选择器(可以连续指定多个):`.a-class.another-class` -- 子元素选择器:`.the-parent > .the-child` -- 后代选择器:`.the-ancestor .the-descendant` -- 跨自定义组件的后代选择器:`.the-ancestor >>> .the-descendant` -- 多选择器的并集:`#a-node, .some-other-nodes` - -## uni-app x 注意事项 - -1. app-uvue支持的选择器较少,不支持ID选择器,[详见](uni-app-x/css/README.md#选择器) -2. app-uvue的页面滚动,是由页面最外层的scroll-view模拟的,如果页面最外层不是scroll-view,无法使用本api。[详见](uni-app-x/css/README.md#pagescroll) -3. app-uvue的scroll-view滚动时,如需动画,则需要在scroll-view的属性中配置 `scroll-with-animation="true"`,[详见](component/scroll-view.md) -4. scroll-view的滚动,设置其scrollTop即可。[详见](component/scroll-view.md) - -**示例** - -```javascript -uni.pageScrollTo({ - scrollTop: 0, - duration: 300 -}); -``` - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/preview-image.md b/docs/uni-app-x/api/preview-image.md deleted file mode 100644 index a0c13bc436e9a849fe763e40260d885e3c057e88..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/preview-image.md +++ /dev/null @@ -1,33 +0,0 @@ -## uni.previewImage(options) @previewimage - - - - - - - - - - - - - -## uni.closePreviewImage(options) @closepreviewimage - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/prompt.md b/docs/uni-app-x/api/prompt.md deleted file mode 100644 index 9927e1ea4c4c1c6a97010c12f5cfd53a56ce3906..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/prompt.md +++ /dev/null @@ -1,78 +0,0 @@ -## uni.showToast(options) @showtoast - - - - - - - - - - - - - -#### 注意事项 #### - -+ `position` 参数`android`平台特别说明 - -如果没有设置 `position` 字段,`uni.showToast` 会采用应用弹窗方案,即弹窗与页面生命周期绑定。 页面关闭时,当前页面弹出的所有弹窗都会被自动取消。 - -如果设置了`position` 字段,`uni.showToast` 会采用系统弹窗方案,即弹窗与页面无绑定关系。 页面关闭后,弹出中的/等待弹出的`Toast`会继续展示。 - -系统弹窗在部分系统(比如 MIUI,Google)可能会有应用图标前缀。 - -系统弹窗在部分系统(比如 鸿蒙 4.0以上)可能不支持顶部和居中展示。 - - - -## uni.showLoading(options) @showloading - - - - - - - - - - - - - -## uni.showModal(options) @showmodal - - - - - - - - - - - - - -## uni.showActionSheet(options) @showactionsheet - - - - - - - - - - - - - - - - - - - -## Bug & Tips@tips -- 在页面生命周期 onLoad 中调用以上弹窗 API 可能无法正常显示,暂时建议在页面生命周期 onReady 及之后再调用。此bug已于HBuilderX 3.97+修复 diff --git a/docs/uni-app-x/api/pull-down-refresh.md b/docs/uni-app-x/api/pull-down-refresh.md deleted file mode 100644 index 3f1dcd58ea418e13986f718bc19f34dc72d21668..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/pull-down-refresh.md +++ /dev/null @@ -1,38 +0,0 @@ -## uni.startPullDownRefresh(options?) @startpulldownrefresh - - - - - - - - - - - -## uni.stopPullDownRefresh() @stoppulldownrefresh - - - -使用: -1. 首先pages.json里配置了页面可下拉刷新`"enablePullDownRefresh": true` -2. 当用户下拉页面时触发页面生命周期`onPullDownRefresh` -3. 在合适的时机(如联网刷新数据结束),调用本API`uni.stopPullDownRefresh()`,结束下拉刷新状态 - -本API仅负责页面下拉刷新。如使用组件下拉刷新,另见scroll-view、list-view等组件的文档。 - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/push.md b/docs/uni-app-x/api/push.md deleted file mode 100644 index fe1e3f25dce490a56b7453126ebed05268df82e8..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/push.md +++ /dev/null @@ -1,148 +0,0 @@ -# uni-push - -uni-push是DCloud与合作伙伴个推共同推出的统一推送服务。用于从服务器端推送消息到客户端。 - -它包括在线推送、离线推送,聚合了Apple、华为、小米、OPPO、VIVO、魅族、荣耀(3.99+)、Google等多个手机厂商的推送通道。 - -若不使用服务器推送,仅想创建手机通知栏本地消息,也需要使用本模块的API。 - -它是一个云端一体的业务,涉及多份文档: -1. 业务介绍:对于未使用过uni-push的新用户,本文必读:[uni-push业务介绍](https://uniapp.dcloud.net.cn/unipush-v2.html) -2. 客户端API,即本文 -3. 服务器API,[另见](https://uniapp.dcloud.net.cn/uniCloud/uni-cloud-push/api) - - -## uni.getPushClientId(options) @getpushclientid - - - - - - - - - - - -## uni.onPushMessage(callback) @onpushmessage - - - - - - - - - - - -### 注意事项 - -* 如果多次监听`onPushMessage`,那么事件也会多次触发,所以当不需要监听的时候需要`offPushMessage`。 - -## uni.offPushMessage(callback) @offpushmessage - - - - - - - - - - - -## uni.getChannelManager() @getchannelmanager - - - - - - - - - - - -### 注意事项 - -* 由于各大厂商限制推送频次,当使用厂商离线推送的时,需要在不同品牌手机后台开通自分类权益,[限制数量说明](https://docs.getui.com/getui/mobile/vendor/qps/) - - [华为](https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/message-classification-0000001149358835) - - [小米](https://dev.mi.com/console/doc/detail?pId=2422) - - [oppo](https://open.oppomobile.com/new/developmentDoc/info?id=11227) - - [vivo](https://dev.vivo.com.cn/documentCenter/doc/359) - - 开通自分类权益后,需要客户端创建channel,因此客户端提供了`setPushChannel`来进行channel的创建,通过此Api来创建渠道进行推送。 - 客户端创建渠道成功后,即可通过云函数进行推送,[uni-push2服务端文档](https://uniapp.dcloud.net.cn/uniCloud/uni-cloud-push/api.html)。 - - -* 由于Android通知渠道的机制问题,一旦通知渠道建立,便不能修改此渠道的配置,即使删除渠道后再次创建同channelId名称的渠道,也不会改变原先渠道的配置(除非删除应用),最明显的现象就是铃声动态修改失败,比如调用`setPushChannel`时,第一次的设置参数是`{"channelId":"test","soundName":"pushsound"}` , 这时你想切换铃音,你的channelId就不能再叫test了,而应该为`{"channelId":"test2","soundName":"ring"}` ,此时会新建一个渠道。 - - - -## uni.createPushMessage(options) @createpushmessage - - - - - - - - - - - - - - - -## 示例代码 - -hello uni-push是可跑通、同时包含客户端和服务器完整流程的代码。[https://gitcode.net/dcloud/hello-uni-push](https://gitcode.net/dcloud/hello-uni-push) - -在业务开通、配置正确的情况下,执行项目下的云函数,即可给客户端发送消息。 - -## 注意事项 - -* 关于隐私安全问题,由于在调用`getPushClientId`或者`onPushMessage`时,才会初始化个推SDK,所以开发者要确保弹出隐私框之前不调用此两项API。 -* 关于图标的配置,需要创建[nativeResources](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#%E5%BA%94%E7%94%A8%E8%B5%84%E6%BA%90)目录,放置对应分辨率的图片资源即可 ,目录配置如下 - - ``` - ├── nativeResources - │   └── android - │   └── res - │   ├── drawable-ldpi - │   │   ├── push.png // 分辨率要求48x48 - │   │   └── push_small.png // 分辨率要求18x18 - │   ├── drawable-mdpi - │   │   ├── push.png // 分辨率要求64x64 - │   │   └── push_small.png // 分辨率要求24x24 - │   ├── drawable-hdpi - │   │   ├── push.png // 分辨率要求96x96 - │   │   └── push_small.png // 分辨率要求36x36 - │   ├── drawable-xhdpi - │   │   ├── push.png // 分辨率要求128x128 - │   │   └── push_small.png // 分辨率要求48x48 - │   ├── drawable-xxhdpi - │   │   ├── push.png // 分辨率要求192x192 - │   │   └── push_small.png // 分辨率要求72x72 - │   ├── drawable-xxxhdpi - │   │   └── push_small.png // 分辨率要求96x96 - │   └── raw - │   └── pushsound.mp3 // 声音文件, 自定义推送铃音时使用 - ``` - -* `setPushChannel`设置新建渠道时,`soundName`字段的值为nativeResources->android->res->raw中存放的音频文件名称,注意不要带文件的后缀,比如`pushsound.mp3`文件,例: - ``` - const channelManager = getChannelManager() - channelManager.setPushChannel({ - channelId: "test1", - channelDesc: "test1 desc", - soundName: "pushsound" - }) - ``` -* uni-app x 的push模块仅支持uni-push2,不再支持uni-push1。但这不意味着强绑uniCloud的付费行为。而是DCloud的所有云服务都将统一纳入到uniCloud体系管理,开发者在开通uni-push2后,也可以拿到mastersecret,然后在自己的服务器去直接连接个推服务器。 -* uni-push是一个独立的模块,在标准基座中并不包含。开发push需要首先编写push相关代码,然后打包自定义基座,根据摇树规则,打出的自定义基座才会包含push模块。详见[摇树](../manifest.md#treeShaking) -* 创建本地通知栏,理论上可以和个推的服务无关。但目前也都包含在push模块里了。如果您不需要服务器推送,只需要本地创建通知栏,也需要打包push模块才行。 -* 部分手机创建本地通知时,App如果在后台状态,点击通知消息并不会拉起App,原因是厂商增加了后台弹窗权限,需要用户手动打开此权限。 -* 获取手机端app是否拥有push权限,请使用API [uni.getAppAuthorizeSetting](get-app-authorize-setting.md) \ No newline at end of file diff --git a/docs/uni-app-x/api/request.md b/docs/uni-app-x/api/request.md deleted file mode 100644 index 4822b2a8d3f69d6fe2bcef72d39e9f1ce924c55b..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/request.md +++ /dev/null @@ -1,26 +0,0 @@ -## uni.request(param) @request - - - - - - - - - - - - - -## 注意事项 - -* request 接口内部通过[特殊方式读取了泛型类型](../../uts/generics.md#使用限制),不支持传入动态的泛型:比如将外层方法的普通泛型参数传入 request。 -* 如果使用泛型先创建RequestOptions实例,再传入uni.request(),此时请务必确保request要显式指定泛型,例: - ```typescript - const options: RequestOptions = ... - uni.request(options) - ``` - - - - diff --git a/docs/uni-app-x/api/save-image-to-photos-album.md b/docs/uni-app-x/api/save-image-to-photos-album.md deleted file mode 100644 index 5c2e86cfeb5557a6e315803d3bb53dbc3893f7a3..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/save-image-to-photos-album.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.saveImageToPhotosAlbum(options) @saveimagetophotosalbum - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/set-navigation-bar-color.md b/docs/uni-app-x/api/set-navigation-bar-color.md deleted file mode 100644 index a85521c0315d0ce0d99f995512fec2962875f1d5..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/set-navigation-bar-color.md +++ /dev/null @@ -1,21 +0,0 @@ -## uni.setNavigationBarColor(options) @setnavigationbarcolor - - - -即便pages.json里没有配置NavigationBar,如需修改状态栏的前景背景,也需要本API。 - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/set-navigation-bar-title.md b/docs/uni-app-x/api/set-navigation-bar-title.md deleted file mode 100644 index 90561372682cdf8a7a08b2a285dbc33bc0a8bbdf..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/set-navigation-bar-title.md +++ /dev/null @@ -1,15 +0,0 @@ -## uni.setNavigationBarTitle(options) @setnavigationbartitle - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/set-tabbar.md b/docs/uni-app-x/api/set-tabbar.md deleted file mode 100644 index 6448192ed902f2caab2851d37ea218193dd52577..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/set-tabbar.md +++ /dev/null @@ -1,115 +0,0 @@ -## uni.setTabBarBadge(options) @settabbarbadge - - - - - - - - - - - - - -## uni.removeTabBarBadge(options) @removetabbarbadge - - - - - - - - - - - - - -## uni.setTabBarItem(options) @settabbaritem - - - - - - - - - - - - - -## uni.setTabBarStyle(options) @settabbarstyle - - - - - - - - - - - - - -## uni.hideTabBar(options?) @hidetabbar - - - - - - - - - - - - - -## uni.showTabBar(options?) @showtabbar - - - - - - - - - - - - - -## uni.showTabBarRedDot(options) @showtabbarreddot - - - - - - - - - - - - - -## uni.hideTabBarRedDot(options) @hidetabbarreddot - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/storage.md b/docs/uni-app-x/api/storage.md deleted file mode 100644 index 90e3880d7d82e75e1230e6b358b2adf17dc746ec..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/storage.md +++ /dev/null @@ -1,162 +0,0 @@ -## key-value本地数据存储 - -app、小程序、web,均提供了方便的key-value模式的本地数据存储,通过键值对的方式存取数据。 - -uni-app的Storage在不同端的实现不同: -- H5端为localStorage,浏览器限制5M大小,是缓存概念,可能会被清理 -- App端为原生storage,无大小限制,不是缓存,是持久化的 -- 各个小程序端为其自带的storage api,数据存储生命周期跟小程序本身一致,即除用户主动删除或超过一定时间被自动清理,否则数据都一直可用。 - * 微信小程序单个 key 允许存储的最大数据长度为 1MB,所有数据存储上限为 10MB。 - * 支付宝小程序单条数据转换成字符串后,字符串长度最大200*1024。同一个支付宝用户,同一个小程序缓存总上限为10MB。 - * 百度小程序策略[详见](https://smartprogram.baidu.com/docs/develop/api/storage/save_process/) - * 抖音小程序策略[详见](https://developer.open-douyin.com/docs/resource/zh-CN/mini-app/develop/api/data-caching/tt-get-storage) - -**注意** -- `uni-`、`uni_`、`dcloud-`、`dcloud_`为前缀的key,为系统保留关键前缀。如`uni_deviceId`、`uni_id_token`,请开发者为key命名时避开这些前缀。 -- 非App平台清空Storage会导致uni.getSystemInfo获取到的deviceId改变 - -## uni.setStorage(options) @setstorage - - - - - - - - - - - - - -## uni.setStorageSync(key, data) @setstoragesync - - - - - - - - - - - - - -## uni.getStorage(options) @getstorage - - - - - - - - - - - - - -## uni.getStorageSync(key) @getstoragesync - - - - - - - - - - - - - -## uni.getStorageInfo(options) @getstorageinfo - - - - - - - - - - - - - -## uni.getStorageInfoSync() @getstorageinfosync - - - - - - - - - - - - - -## uni.removeStorage(options) @removestorage - - - - - - - - - - - - - -## uni.removeStorageSync(key) @removestoragesync - - - - - - - - - - - - - -## uni.clearStorage(option?) @clearstorage - - - - - - - - - - - - - -## uni.clearStorageSync() @clearstoragesync - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/unicloud/README.md b/docs/uni-app-x/api/unicloud/README.md deleted file mode 100644 index 6464c560ff6d3639d3cd9a6f42f4a60f26418cd2..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/unicloud/README.md +++ /dev/null @@ -1,25 +0,0 @@ -## 概述 - -截止到目前,uni-app x下的uniCloud还不支持: - -- 暂不支持schema2code -- 暂不支持安全网络 -- 暂不支持泛型 -- 暂不支持pages.json中的uniIdRouter -- 本文档未列举的API均不支持 - -**兼容说明** - -- `HBuilderX 3.9+`支持阿里云,`3.91+`支持腾讯云,`3.98+`支持支付宝小程序云 -- `HBuilderX 3.91+`支持clientDB,但不支持getOne和multiSend - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/unicloud/database.md b/docs/uni-app-x/api/unicloud/database.md deleted file mode 100644 index 17c6057b953bedb6f513a769d273c7f80bdde4af..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/unicloud/database.md +++ /dev/null @@ -1,19 +0,0 @@ -## databaseForJQL() @databaseforjql - -**和uni-app项目接口差异** - -- uni-app x项目内数据库的客户端接口仅支持databaseForJQL不再支持database方法。 -- action云函数因为安全问题已经不再推荐使用。开发者应使用[数据库触发器](https://uniapp.dcloud.net.cn/uniCloud/jql-schema-ext.html)来实现相关功能。 -- 暂不支持multiSend - - - - - - - - - - - - diff --git a/docs/uni-app-x/api/unicloud/function.md b/docs/uni-app-x/api/unicloud/function.md deleted file mode 100644 index 686c0ff1ca9859d8edeaf0eaf4f13786817eefde..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/unicloud/function.md +++ /dev/null @@ -1,13 +0,0 @@ -## callFunction(options) @callfunction - - - - - - - - - - - - diff --git a/docs/uni-app-x/api/unicloud/object.md b/docs/uni-app-x/api/unicloud/object.md deleted file mode 100644 index 91ba78f5ef49f952e4d51b26015000ef636de314..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/unicloud/object.md +++ /dev/null @@ -1,35 +0,0 @@ -## importObject(objectName, options?) @importobject - - - - - - - - - - - -### uni-app x内使用云对象的特殊说明@strictly-typed-object - -由于强类型语言的限制,uni-app-x在编译时需要读取本地云对象导出的方法列表生成客户端对象。 -- 请确保调用的云对象在本地包含导出的方法。 -- 请确保本地工程的云对象的方法是正确的。 -- 如由于云函数加密等因素导致`index.obj.js`无法被正确解析,请在云对象目录创建`index.obj.d.ts`声明云对象内包含的方法。`index.obj.d.ts`示例代码如下: - -```ts -// interface.d.ts -type AnyFunction = (...args: any[]) => any; - -declare const add: AnyFunction -declare const update: AnyFunction -declare const deleteRecord: AnyFunction - -export { // 上面的写法可以自己调整,仅需保证export内包含所有方法即可 - add, - update - deleteRecord as remove -} -``` - - \ No newline at end of file diff --git a/docs/uni-app-x/api/unicloud/storage.md b/docs/uni-app-x/api/unicloud/storage.md deleted file mode 100644 index 8de3c2efbe85e6a83589823830692a40f2227310..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/unicloud/storage.md +++ /dev/null @@ -1,41 +0,0 @@ -## uploadFile(options) @uploadfile - - - - - - - - - - - - - -## chooseAndUploadFile(options) @chooseanduploadfile - - - - - - - - - - - - - -## getTempFileURL(options) @gettempfileurl - - - - - - - - - - - - diff --git a/docs/uni-app-x/api/unicloud/utils.md b/docs/uni-app-x/api/unicloud/utils.md deleted file mode 100644 index 0c4963f579807e8a58bfdb02fc2da84787c3d135..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/unicloud/utils.md +++ /dev/null @@ -1,59 +0,0 @@ -## onResponse(callback) @onresponse - - - - - - - - - - - -## offResponse(callback) @offresponse - - - - - - - - - - - -## onRefreshToken(callback) @onrefreshtoken - - - - - - - - - - - -## offRefreshToken(callback) @offrefreshtoken - - - - - - - - - - - -## getCurrentUserInfo() @getcurrentuserinfo - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/upload-file.md b/docs/uni-app-x/api/upload-file.md deleted file mode 100644 index 5b0d9157b5cbd1be5b1d0e168f3a6efb416f3260..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/upload-file.md +++ /dev/null @@ -1,19 +0,0 @@ -## uni.uploadFile(options) @uploadfile - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/websocket-global.md b/docs/uni-app-x/api/websocket-global.md deleted file mode 100644 index eb55a660c3ddfb49d2b2263c4b3272e7dc07ec81..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/websocket-global.md +++ /dev/null @@ -1,107 +0,0 @@ -## uni.connectSocket(options) @connectsocket - - - - - - - - - - - - - -## uni.onSocketOpen(options) @onsocketopen - - - - - - - - - - - - - -## uni.onSocketError(callback) @onsocketerror - - - - - - - - - - - - - -## uni.sendSocketMessage(options) @sendsocketmessage - - - - - - - - - - - - - -## 注意事项 - -* 出于性能的权衡,在底层实现上发送队列占用的内存不能超过16M,一旦超过将导致连接被关闭。 - -## uni.onSocketMessage(callback) @onsocketmessage - - - - - - - - - - - - - -## uni.closeSocket(options) @closesocket - - - - - - - - - - - - - -## uni.onSocketClose(callback) @onsocketclose - - - - - - - - - - - - - - - - - - diff --git a/docs/uni-app-x/api/websocket.md b/docs/uni-app-x/api/websocket.md deleted file mode 100644 index b9da054dff0d3f3480f2d49660c816be2dd792ca..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/websocket.md +++ /dev/null @@ -1,101 +0,0 @@ -## uni.connectSocket(options) @connectsocket - - - - - - - - - - - - - -## uni.onSocketOpen(options) @onsocketopen - - - - - - - - - - - - - -## uni.onSocketError(callback) @onsocketerror - - - - - - - - - - - - - -## uni.sendSocketMessage(options) @sendsocketmessage - - - - - - - - - - - - - -## uni.onSocketMessage(callback) @onsocketmessage - - - - - - - - - - - - - -## uni.closeSocket(options) @closesocket - - - - - - - - - - - - - -## uni.onSocketClose(callback) @onsocketclose - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/api/wifi.md b/docs/uni-app-x/api/wifi.md deleted file mode 100644 index dd025932d96e812688abd676196f1540eeed10fd..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/api/wifi.md +++ /dev/null @@ -1,123 +0,0 @@ -## uni.startWifi(option) @startwifi - - - - - - - - - - - -## uni.stopWifi(option) @stopwifi - - - - - - - - - - - -## uni.connectWifi(option) @connectwifi - - - - - - - - - - - -## uni.getWifiList(option) @getwifilist - - - - - - - - - - - -## uni.onGetWifiList(UniWifiCallback) @ongetwifilist - - - - - - - - - - - -## uni.offGetWifiList(UniWifiCallback) @offgetwifilist - - - - - - - - - - - -## uni.getConnectedWifi(option) @getconnectedwifi - - - - - - - - - - - -## uni.onWifiConnected(UniWifiCallback) @onwificonnected - - - - - - - - - - - -## uni.onWifiConnectedWithPartialInfo(UniWifiCallback) @onwificonnectedwithpartialinfo - - - - - - - - - - - -## uni.offWifiConnected(callback?) @offwificonnected - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/uni-app-x/collocation/_sidebar.md b/docs/uni-app-x/collocation/_sidebar.md deleted file mode 100644 index 80cec3ba03a773a75bcf309791b3104e07bdf810..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/collocation/_sidebar.md +++ /dev/null @@ -1,9 +0,0 @@ -* [pages.json](pagesjson.md) -* [main.uts](https://uniapp.dcloud.net.cn/collocation/main.html) -* [app.uvue](app.md) -* manifest.json - * [概述](manifest.md) - * [模块配置](manifest-modules.md) - * [启动界面](manifest-splashscreen.md) -* [AndroidManifest.xml](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html) -* [uni.scss](https://uniapp.dcloud.net.cn/collocation/uni-scss.html) \ No newline at end of file diff --git a/docs/uni-app-x/collocation/app.md b/docs/uni-app-x/collocation/app.md deleted file mode 100644 index 020ab2c0182fa24b0d30bc58b735367975e586df..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/collocation/app.md +++ /dev/null @@ -1,96 +0,0 @@ -# App.uvue - -`App.uvue`是uni-app-x的主组件。 - -所有页面都是在`App.uvue`下进行切换的,是应用入口文件。但`App.uvue`本身不是页面,这里不能编写视图元素,也就是没有`