fix: uts api 示例

7ed82467 · DCloud_LXH · 3648170f · 7ed82467 · 7ed82467 · 7ed82467
34 changed file
--- a/docs/.vuepress/utils/utsApiJson.json
+++ b/docs/.vuepress/utils/utsApiJson.json
--- a/docs/api/choose-image.md
+++ b/docs/api/choose-image.md
@@ -10,7 +10,7 @@

 <!-- UTSAPIJSON.chooseImage.tutorial -->

-<!-- UTSAPIJSON.choose-image.example -->
+<!-- UTSAPIJSON.chooseImage.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/choose-video.md
+++ b/docs/api/choose-video.md
@@ -10,7 +10,7 @@

 <!-- UTSAPIJSON.chooseVideo.tutorial -->

-<!-- UTSAPIJSON.choose-video.example -->
+<!-- UTSAPIJSON.chooseVideo.example -->

 <!-- UTSAPIJSON.general_type.name -->

@@ -19,4 +19,4 @@
 ## Tips
 * 本API会自动申请摄像头和相册权限，如需手动获取app是否拥有摄像头和相册权限，参考 [uni.getAppAuthorizeSetting](get-app-authorize-setting.md)
 * app端拍摄和相册选择会在应用沙盒目录的cache目录产生临时文件，位置[详见](file-system-spec.md#cache)。
-* app端如需主动删除临时文件，使用[uni.getFileSystemManager](get-file-system-manager.md)。
\ No newline at end of file
+* app端如需主动删除临时文件，使用[uni.getFileSystemManager](get-file-system-manager.md)。
--- a/docs/api/compress-image.md
+++ b/docs/api/compress-image.md
@@ -10,7 +10,7 @@

 <!-- UTSAPIJSON.compressImage.tutorial -->

-<!-- UTSAPIJSON.compress-image.example -->
+<!-- UTSAPIJSON.compressImage.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/compress-video.md
+++ b/docs/api/compress-video.md
@@ -10,7 +10,7 @@

 <!-- UTSAPIJSON.compressVideo.tutorial -->

-<!-- UTSAPIJSON.compress-video.example -->
+<!-- UTSAPIJSON.compressVideo.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/download-file.md
+++ b/docs/api/download-file.md
@@ -21,8 +21,6 @@

 <!-- UTSAPIJSON.downloadFile.tutorial -->

-<!-- UTSAPIJSON.download-file.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->

--- a/docs/api/event-bus.md
+++ b/docs/api/event-bus.md
@@ -54,7 +54,7 @@

 <!-- UTSAPIJSON.$emit.tutorial -->

-<!-- UTSAPIJSON.event-bus.example -->
+<!-- UTSAPIJSON.eventBus.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/facial-recognition-meta-info.md
+++ b/docs/api/facial-recognition-meta-info.md
@@ -17,7 +17,9 @@ uni-id-pages，已经内置实人认证，从云端到客户端均已开发好

 <!-- UTSAPIJSON.getFacialRecognitionMetaInfo.param -->

-<!-- UTSAPIJSON.getFacialRecognitionMetaInfo.returnValue -->
+<!-- UTSAPIJSON.getFacialRecognitionMetaInfo.example -->
+
+<!-- UTSAPIJSON.getFacialRecognitionMetaInfo.tutorial -->

 <!-- UTSAPIJSON.getFacialRecognitionMetaInfo.tutorial -->

@@ -31,9 +33,11 @@ uni-id-pages，已经内置实人认证，从云端到客户端均已开发好

 <!-- UTSAPIJSON.startFacialRecognitionVerify.returnValue -->

+<!-- UTSAPIJSON.startFacialRecognitionVerify.example -->
+
 <!-- UTSAPIJSON.startFacialRecognitionVerify.tutorial -->

-<!-- UTSAPIJSON.facial-recognition-verify.example -->
+<!-- UTSAPIJSON.facialRecognitionVerify.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/get-app-authorize-setting.md
+++ b/docs/api/get-app-authorize-setting.md
@@ -22,8 +22,6 @@ Android和iOS的权限设计并不相同，比如iOS有相册权限，Android则

 本API只返回部分权限，Android平台的权限非常多，在Android上获取所有未授权权限，另见[UTSAndroid.getSystemPermissionDenied](../uts/utsandroid.md#getsystempermissiondenied)，这里的权限名称就是Android原始的权限名称了。

-<!-- UTSAPIJSON.get-app-authorize-setting.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/get-app-base-info.md
+++ b/docs/api/get-app-base-info.md
@@ -14,8 +14,6 @@

 <!-- UTSAPIJSON.getAppBaseInfo.tutorial -->

-<!-- UTSAPIJSON.get-app-base-info.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/get-app.md
+++ b/docs/api/get-app.md
@@ -12,8 +12,6 @@

 <!-- UTSAPIJSON.getApp.tutorial -->

-<!-- UTSAPIJSON.get-app.example -->
-
 以上示例，getApp()后调用了app.uvue里定义的increasetLifeCycleNum方法。app.uvue的源码[另见](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/App.uvue)

 <!-- UTSAPIJSON.general_type.name -->

--- a/docs/api/get-battery-info.md
+++ b/docs/api/get-battery-info.md
@@ -26,8 +26,6 @@

 <!-- UTSAPIJSON.getBatteryInfoSync.tutorial -->

-<!-- UTSAPIJSON.get-battery-info.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/get-current-pages.md
+++ b/docs/api/get-current-pages.md
@@ -31,15 +31,10 @@
 - app-android平台的页面是activity，不支持`backgroundColorContent`设为透明。
 - 4.15版本前，app-ios平台在page.json 中设置页面 `enablePullDownRefresh` 为 `false` 时，无法通过 `$setPageStyle` 方法动态开启页面下拉刷新。新版已修复该问题。

-
 <!-- UTSAPIJSON.getCurrentPages.example -->

-
-
 <!-- UTSAPIJSON.getCurrentPages.tutorial -->

-<!-- UTSAPIJSON.get-current-pages.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/get-device-info.md
+++ b/docs/api/get-device-info.md
@@ -8,18 +8,16 @@

 <!-- UTSAPIJSON.getDeviceInfo.returnValue -->

-::: warning 注意事项  
- 获取OAID、AndroidID等其他设备信息，[见插件市场](https://ext.dcloud.net.cn/search?q=oaid&orderBy=Relevance&uni-appx=1)  
- romName值域候选 [详见](./get-system-info.md#romName)  
- app平台devicePixelRatio属性，HBuilderX4.22及以下版本类型为string，HBuilderX4.23版本调整为number  
+::: warning 注意事项
+- 获取OAID、AndroidID等其他设备信息，[见插件市场](https://ext.dcloud.net.cn/search?q=oaid&orderBy=Relevance&uni-appx=1)
+- romName值域候选 [详见](./get-system-info.md#romName)
+- app平台devicePixelRatio属性，HBuilderX4.22及以下版本类型为string，HBuilderX4.23版本调整为number
 :::

 <!-- UTSAPIJSON.getDeviceInfo.example -->

 <!-- UTSAPIJSON.getDeviceInfo.tutorial -->

-<!-- UTSAPIJSON.get-device-info.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/get-image-info.md
+++ b/docs/api/get-image-info.md
@@ -10,7 +10,7 @@

 <!-- UTSAPIJSON.getImageInfo.tutorial -->

-<!-- UTSAPIJSON.get-image-info.example -->
+<!-- UTSAPIJSON.getImageInfo.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/get-launch-options-sync.md
+++ b/docs/api/get-launch-options-sync.md
@@ -12,8 +12,6 @@

 <!-- UTSAPIJSON.getLaunchOptionsSync.tutorial -->

-<!-- UTSAPIJSON.get-launch-options-sync.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/get-location.md
+++ b/docs/api/get-location.md
@@ -30,7 +30,7 @@ uni-app x的标准基座定位仅支持wgs84坐标系、不支持逆地址解析

 <!-- UTSAPIJSON.getLocation.tutorial -->

-<!-- UTSAPIJSON.get-location.example -->
+<!-- UTSAPIJSON.getLocation.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/get-network-type.md
+++ b/docs/api/get-network-type.md
@@ -12,8 +12,6 @@

 <!-- UTSAPIJSON.getNetworkType.tutorial -->

-<!-- UTSAPIJSON.get-network-type.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/get-performance.md
+++ b/docs/api/get-performance.md
@@ -10,7 +10,7 @@

 <!-- UTSAPIJSON.getPerformance.tutorial -->

-<!-- UTSAPIJSON.get-performance.example -->
+<!-- UTSAPIJSON.getPerformance.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/get-provider.md
+++ b/docs/api/get-provider.md
@@ -30,7 +30,7 @@ uni-app 通过 provider 机制来统一不同的SDK，屏蔽他们的差异。

 <!-- UTSAPIJSON.getProvider.tutorial -->

-<!-- UTSAPIJSON.get-provider.example -->
+<!-- UTSAPIJSON.getProvider.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/get-system-info.md
+++ b/docs/api/get-system-info.md
@@ -81,8 +81,6 @@ uni-app 提供了异步(`uni.getSystemInfo`)和同步(`uni.getSystemInfoSync`)

 <!-- UTSAPIJSON.getSystemInfoSync.tutorial -->

-<!-- UTSAPIJSON.get-system-info.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/get-system-setting.md
+++ b/docs/api/get-system-setting.md
@@ -12,8 +12,6 @@

 <!-- UTSAPIJSON.getSystemSetting.tutorial -->

-<!-- UTSAPIJSON.get-system-setting.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/get-video-info.md
+++ b/docs/api/get-video-info.md
@@ -10,7 +10,7 @@

 <!-- UTSAPIJSON.getVideoInfo.tutorial -->

-<!-- UTSAPIJSON.get-video-info.example -->
+<!-- UTSAPIJSON.getVideoInfo.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/get-window-info.md
+++ b/docs/api/get-window-info.md
@@ -8,17 +8,15 @@

 <!-- UTSAPIJSON.getWindowInfo.returnValue -->

-::: warning 注意事项  
+::: warning 注意事项
 - Android端的`windowHeight`属性是有时机的考量的，如果在全局作用域获取`windowHeight`，有可能当前Activity还未加载，所以导航栏和Tabbar的高度是不会计算进去的，稳妥起见，建议在`onReady`或者`onPageShow`内获取`windowheight`。
 - 仅iOS有安全区概念
-:::  
+:::

 <!-- UTSAPIJSON.getWindowInfo.example -->

 <!-- UTSAPIJSON.getWindowInfo.tutorial -->

-<!-- UTSAPIJSON.get-window-info.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/install-apk.md
+++ b/docs/api/install-apk.md
@@ -12,7 +12,7 @@

 <!-- UTSAPIJSON.installApk.tutorial -->

-<!-- UTSAPIJSON.install-apk.example -->
+<!-- UTSAPIJSON.installApk.example -->

 ## Tips
 - HBuilderX 3.99以前，uni.install是ext api，需单独[下载](https://ext.dcloud.net.cn/plugin?id=15118)。从HBuilderX 3.99起 uni-app x 内置了该api，无需再单独下载。

--- a/docs/api/load-font-face.md
+++ b/docs/api/load-font-face.md
@@ -31,8 +31,6 @@ uni.loadFontFace({

 <!-- UTSAPIJSON.loadFontFace.tutorial -->

-<!-- UTSAPIJSON.load-font-face.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/page-scroll-to.md
+++ b/docs/api/page-scroll-to.md
@@ -45,8 +45,6 @@ uni.pageScrollTo({
 });
 ```

-<!-- UTSAPIJSON.page-scroll-to.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/preview-image.md
+++ b/docs/api/preview-image.md
@@ -26,8 +26,6 @@

 <!-- UTSAPIJSON.closePreviewImage.tutorial -->

-<!-- UTSAPIJSON.preview-image.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/pull-down-refresh.md
+++ b/docs/api/pull-down-refresh.md
@@ -31,8 +31,6 @@

 <!-- UTSAPIJSON.stopPullDownRefresh.tutorial -->

-<!-- UTSAPIJSON.pull-down-refresh.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/save-image-to-photos-album.md
+++ b/docs/api/save-image-to-photos-album.md
@@ -12,8 +12,6 @@

 <!-- UTSAPIJSON.saveImageToPhotosAlbum.tutorial -->

-<!-- UTSAPIJSON.save-image-to-photos-album.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/save-video-to-photos-album.md
+++ b/docs/api/save-video-to-photos-album.md
@@ -10,7 +10,7 @@

 <!-- UTSAPIJSON.saveVideoToPhotosAlbum.tutorial -->

-<!-- UTSAPIJSON.save-video-to-photos-album.example -->
+<!-- UTSAPIJSON.saveVideoToPhotosAlbum.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/set-navigation-bar-color.md
+++ b/docs/api/set-navigation-bar-color.md
@@ -16,8 +16,6 @@

 <!-- UTSAPIJSON.setNavigationBarColor.tutorial -->

-<!-- UTSAPIJSON.set-navigation-bar-color.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->
--- a/docs/api/theme-change.md
+++ b/docs/api/theme-change.md
@@ -119,7 +119,7 @@ uni.offOsThemeChange(callbackId)

 <!-- UTSAPIJSON.offOsThemeChange.tutorial -->

-<!-- UTSAPIJSON.theme-change.example -->
+<!-- UTSAPIJSON.offOsThemeChange.example -->

 <!-- UTSAPIJSON.general_type.name -->


--- a/docs/api/upload-file.md
+++ b/docs/api/upload-file.md
@@ -14,8 +14,6 @@

 <!-- UTSAPIJSON.uploadFile.tutorial -->

-<!-- UTSAPIJSON.upload-file.example -->
-
 <!-- UTSAPIJSON.general_type.name -->

 <!-- UTSAPIJSON.general_type.param -->