diff --git a/docs/.vuepress/utils/utsApiJson.json b/docs/.vuepress/utils/utsApiJson.json
index 12136240f1341c6214e2a7a140b821594c67c393..b9292e029c30844395a94c10cdc1568407059361 100644
--- a/docs/.vuepress/utils/utsApiJson.json
+++ b/docs/.vuepress/utils/utsApiJson.json
@@ -1 +1 @@
-{"getApp":{"name":"## getApp() @getapp","description":"\r\n`getApp()` 函数用于获取当前应用实例,可通过应用实例调用 App.uvue methods 中定义的方法。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"","tutorial":"\n### 参见\n[getApp](https://uniapp.dcloud.net.cn/tutorial/page.html#getapp)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.global.get-app)\n"},"get-app":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app/get-app.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-app/get-app\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 初始的 globalData:\r\n globalData string: {{ originGlobalData.str }}\r\n globalData number: {{ originGlobalData.num }}\r\n globalData boolean: {{ originGlobalData.bool }}\r\n globalData object: {{ originGlobalData.obj }}\r\n globalData null: {{ originGlobalData.null }}\r\n globalData array: {{ originGlobalData.arr }}\r\n globalData Set: {{ originGlobalData.mySet }}\r\n globalData Map: {{ originGlobalData.myMap }}\r\n globalData func 返回值: {{ originGlobalDataFuncRes }}\r\n \r\n \r\n \r\n 更新后的 globalData:\r\n globalData string: {{ newGlobalData.str }}\r\n globalData number: {{ newGlobalData.num }}\r\n globalData boolean: {{ newGlobalData.bool }}\r\n globalData object: {{ newGlobalData.obj }}\r\n globalData null: {{ newGlobalData.null }}\r\n globalData array: {{ newGlobalData.arr }}\r\n globalData Set: {{ newGlobalData.mySet }}\r\n globalData Map: {{ newGlobalData.myMap }}\r\n globalData func 返回值: {{ newGlobalDataFuncRes }}\r\n \r\n 点击按钮调用 App.uvue methods\r\n increasetLifeCycleNum 方法\r\n \r\n lifeCycleNum: {{ lifeCycleNum }}\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n type MyGlobalData = {\r\n str : string,\r\n num : number,\r\n bool : boolean,\r\n obj : UTSJSONObject,\r\n null : string | null,\r\n arr : number[],\r\n mySet : string[],\r\n myMap : UTSJSONObject,\r\n func : () => string\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n originGlobalData: {\r\n str: '',\r\n num: 0,\r\n bool: false,\r\n obj: {\r\n str: '',\r\n num: 0,\r\n bool: false\r\n } as UTSJSONObject,\r\n null: null,\r\n arr: [] as number[],\r\n mySet: [] as string[],\r\n myMap: {},\r\n func: () : string => ''\r\n } as MyGlobalData,\r\n originGlobalDataFuncRes: '',\r\n newGlobalData: {\r\n str: '',\r\n num: 0,\r\n bool: false,\r\n obj: {\r\n str: '',\r\n num: 0,\r\n bool: false\r\n } as UTSJSONObject,\r\n null: null,\r\n arr: [] as number[],\r\n mySet: [] as string[],\r\n myMap: {},\r\n func: () : string => ''\r\n } as MyGlobalData,\r\n newGlobalDataFuncRes: '',\r\n lifeCycleNum: 0,\r\n }\r\n },\r\n onReady() {\r\n this.lifeCycleNum = state.lifeCycleNum\r\n },\r\n methods: {\r\n getGlobalData() {\r\n const app = getApp()\r\n\r\n this.originGlobalData.str = app.globalData.str\r\n this.originGlobalData.num = app.globalData.num\r\n this.originGlobalData.bool = app.globalData.bool\r\n this.originGlobalData.obj = app.globalData.obj\r\n this.originGlobalData.null = app.globalData.null\r\n this.originGlobalData.arr = app.globalData.arr\r\n app.globalData.mySet.forEach((value : string) => {\r\n this.originGlobalData.mySet.push(value)\r\n })\r\n app.globalData.myMap.forEach((value : any, key : string) => {\r\n this.originGlobalData.myMap[key] = value\r\n })\r\n this.originGlobalData.func = app.globalData.func\r\n this.originGlobalDataFuncRes = this.originGlobalData.func()\r\n },\r\n setGlobalData() {\r\n const app = getApp()\r\n\r\n app.globalData.str = 'new globalData str'\r\n app.globalData.num = 100\r\n app.globalData.bool = true\r\n app.globalData.obj = {\r\n str: 'new globalData obj str',\r\n num: 200,\r\n bool: true\r\n }\r\n app.globalData.null = 'not null'\r\n app.globalData.arr = [1, 2, 3]\r\n app.globalData.mySet = new Set(['a', 'b', 'c'])\r\n app.globalData.myMap = new Map([\r\n ['a', 1],\r\n ['b', 2],\r\n ['c', 3]\r\n ])\r\n app.globalData.func = () : string => {\r\n return 'new globalData func'\r\n }\r\n\r\n this.newGlobalData.str = app.globalData.str\r\n this.newGlobalData.num = app.globalData.num\r\n this.newGlobalData.bool = app.globalData.bool\r\n this.newGlobalData.obj = app.globalData.obj\r\n this.newGlobalData.null = app.globalData.null\r\n this.newGlobalData.arr = app.globalData.arr\r\n app.globalData.mySet.forEach((value : string) => {\r\n this.newGlobalData.mySet.push(value)\r\n })\r\n app.globalData.myMap.forEach((value : any, key : string) => {\r\n this.newGlobalData.myMap[key] = value\r\n })\r\n this.newGlobalData.func = app.globalData.func\r\n this.newGlobalDataFuncRes = this.newGlobalData.func()\r\n },\r\n _increasetLifeCycleNum: function () {\r\n const app = getApp()\r\n app.increasetLifeCycleNum()\r\n this.lifeCycleNum = state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n }\r\n },\r\n }\r\n\n```\n\n:::"},"getCurrentPages":{"name":"## getCurrentPages() @getcurrentpages","description":"\r\n`getCurrentPages()` 函数用于获取当前页面栈的实例,以数组形式按栈的顺序给出,数组中的元素为页面实例,第一个元素为首页,最后一个元素为当前页面。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[Page](#page-values)\\> | \n\n#### Page 的属性值 @page-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| route | string | 是 | - | 页面的路由地址 |\n| options | Map\\ | 是 | - | 页面的路由参数信息 |\n","compatibility":"","tutorial":"\n### 参见\n[getCurrentPages](https://uniapp.dcloud.net.cn/tutorial/page.html#getcurrentpages)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.global.get-current-pages)\n"},"get-current-pages":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-current-pages/get-current-pages.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-current-pages/get-current-pages\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n 当前页面栈中 {{ pages.length }} 个页面,列表如下:\r\n \r\n index: {{ index }}, route: {{ page.route }}\r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n class Page {\r\n constructor(public route : string) {\r\n }\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n checked: false,\r\n pages: [] as Page[],\r\n }\r\n },\r\n methods: {\r\n _getCurrentPages: function () {\r\n this.pages.length = 0\r\n const pages = getCurrentPages()\r\n this.pages.push(new Page(pages[0].route))\r\n if (this.pages[0].route.includes('/tabBar/')) {\r\n this.checked = true\r\n }\r\n for (let i = 1; i < pages.length; i++) {\r\n this.pages.push(new Page(pages[i].route))\r\n if (pages[i].route.includes('/tabBar/')) {\r\n this.checked = false\r\n }\r\n }\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"$on":{"name":"## uni.$on(eventName, callback) @$on","description":"\r\n监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| eventName | string | 是 | - | - |\n| callback | () => void | 是 | - | - |","returnValue":"","compatibility":"### $on 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[$on](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#on)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$on)\n"},"$once":{"name":"## uni.$once(eventName, callback) @$once","description":"\r\n监听一个自定义事件。事件只触发一次,在第一次触发之后移除事件监听器。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| eventName | string | 是 | - | - |\n| callback | () => void | 是 | - | - |","returnValue":"","compatibility":"### $once 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[$once](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#once)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$once)\n"},"$off":{"name":"## uni.$off(eventName, callback) @$off","description":"\r\n移除自定义事件监听器。如果没有指定事件名,则移除所有事件监听器。如果提供事件名,则移除该事件的所有监听器。如果提供了事件名和回调,则只移除这个回调的监听器。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| eventName | string | 是 | - | - |\n| callback | () => void | 是 | - | - |","returnValue":"","compatibility":"### $off 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[$off](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#off)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$off)\n"},"$emit":{"name":"## uni.$emit(eventName, args?) @$emit","description":"\r\n触发自定义事件,附加的参数会传递给事件监听器。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| eventName | string | 是 | - | - |\n| args | any | 否 | - | - |","returnValue":"","compatibility":"### $emit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[$emit](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$emit)\n"},"event-bus":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/event-bus/event-bus.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/event-bus/event-bus\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 收到的消息:\r\n \r\n {{ item }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n log: [] as string[],\r\n }\r\n },\r\n methods: {\r\n fn(res : string) {\r\n this.log.push(res)\r\n },\r\n on() {\r\n uni.$on('test', this.fn)\r\n },\r\n once() {\r\n uni.$once('test', this.fn)\r\n },\r\n off() {\r\n uni.$off('test', this.fn)\r\n },\r\n emit() {\r\n uni.$emit('test', 'msg:' + Date.now())\r\n },\r\n clear() {\r\n this.log.length = 0\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"addInterceptor":{"name":"## uni.addInterceptor(name, interceptor) @addinterceptor","description":"\r\n添加拦截器","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | 需要拦截的 API 名称 |\n| interceptor | [Interceptor](#interceptor-values) | 是 | - | 拦截器 |\n#### Interceptor 的属性值 @interceptor-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (...args?: any) => any | 否 | - | 成功回调拦截 |\n| fail | (...args?: any) => any | 否 | - | 失败回调拦截 |\n| complete | (...args?: any) => any | 否 | - | 完成回调拦截 |\n\n#### Interceptor 的方法 @interceptor-values \n\n#### invoke(...args?) @invoke\n\r\n拦截前触发\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| ...args | any | 否 | - | - |\n##### 返回值 \n\n| 类型 |\n| :- |\n| any | \n\n\n\n#### returnValue(...args?) @returnvalue\n\r\n方法调用后触发,处理返回值\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| ...args | any | 否 | - | - |\n##### 返回值 \n\n| 类型 |\n| :- |\n| any | \n\n\n","returnValue":"","compatibility":"### addInterceptor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | x | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.interceptor.addInterceptor)\n"},"removeInterceptor":{"name":"## uni.removeInterceptor(name, interceptor?) @removeinterceptor","description":"\r\n删除拦截器","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | 需要删除拦截器的 API 名称 |\n| interceptor | [Interceptor](#interceptor-values) | 否 | - | 拦截器 |\n#### Interceptor 的属性值 @interceptor-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (...args?: any) => any | 否 | - | 成功回调拦截 |\n| fail | (...args?: any) => any | 否 | - | 失败回调拦截 |\n| complete | (...args?: any) => any | 否 | - | 完成回调拦截 |\n\n#### Interceptor 的方法 @interceptor-values \n\n#### invoke(...args?) @invoke\n\r\n拦截前触发\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| ...args | any | 否 | - | - |\n##### 返回值 \n\n| 类型 |\n| :- |\n| any | \n\n\n\n#### returnValue(...args?) @returnvalue\n\r\n方法调用后触发,处理返回值\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| ...args | any | 否 | - | - |\n##### 返回值 \n\n| 类型 |\n| :- |\n| any | \n\n\n","returnValue":"","compatibility":"### removeInterceptor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | x | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.interceptor.removeInterceptor)\n"},"interceptor":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/interceptor/interceptor.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/interceptor/interceptor\n>Template\n```vue\n\r\n \r\n \r\n \r\n 点击下方按钮{{msg}}\r\n \r\n \r\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n const interceptor = {\r\n invoke: function (options : NavigateToOptions) {\r\n console.log('拦截 navigateTo 接口传入参数为:', options)\r\n const url = './page2'\r\n uni.showToast({\r\n title: `重定向到页面:${url}`\r\n })\r\n options.url = url\r\n },\r\n success: function (res : NavigateBackSuccess) {\r\n console.log('拦截 navigateTo 接口 success 返回参数为:', res)\r\n },\r\n fail: function (err : NavigateToFail) {\r\n console.log('拦截 navigateTo 接口 fail 返回参数为:', err)\r\n },\r\n complete: function (res : NavigateToComplete) {\r\n console.log('拦截 navigateTo 接口 complete 返回参数为:', res)\r\n }\r\n } as Interceptor\r\n export default {\r\n data() {\r\n return {\r\n msg: \"会跳转到测试页面1\"\r\n }\r\n },\r\n beforeUnmount() {\r\n // 移除 navigateTo 所有拦截器\r\n uni.removeInterceptor('navigateTo')\r\n },\r\n methods: {\r\n addInterceptor() {\r\n uni.addInterceptor('navigateTo', interceptor)\r\n uni.showToast({\r\n title: '页面跳转已拦截'\r\n })\r\n this.msg = \",路由被劫持到测试页面2\"\r\n },\r\n removeInterceptor() {\r\n uni.removeInterceptor('navigateTo', interceptor)\r\n uni.showToast({\r\n title: '拦截器已移除'\r\n })\r\n this.msg = \"会跳转到测试页面1\"\r\n },\r\n navigateTo() {\r\n uni.navigateTo({\r\n url: './page1',\r\n success(res) {\r\n console.log('res:', res)\r\n },\r\n fail(err) {\r\n console.error('err:', err)\r\n },\r\n complete(res) {\r\n console.log('res:', res)\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"getLaunchOptionsSync":{"name":"## uni.getLaunchOptionsSync() @getlaunchoptionssync","description":"\r\n获取本次启动时的参数。返回值与App.onLaunch的回调参数一致\r\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [OnLaunchOptions](#onlaunchoptions-values) | \n\n#### OnLaunchOptions 的属性值 @onlaunchoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string | 是 | - | - |\n","compatibility":"### getLaunchOptionsSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[getLaunchOptionsSync](https://doc.dcloud.net.cn/uni-app-x/api/get-launch-options-sync.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.get-launch-options-sync)\n"},"get-launch-options-sync":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-launch-options-sync/get-launch-options-sync.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-launch-options-sync/get-launch-options-sync\n>Template\n```vue\n\r\n \r\n \r\n \r\n 0\" class=\"uni-common-mt\">\r\n 应用启动路径:\r\n {{ launchOptionsPath }}\r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\nexport default {\r\n data() {\r\n return {\r\n checked: false,\r\n homePagePath: 'pages/tabBar/component',\r\n launchOptionsPath: '',\r\n }\r\n },\r\n methods: {\r\n getLaunchOptionsSync() {\r\n const launchOptions = uni.getLaunchOptionsSync()\r\n this.launchOptionsPath = launchOptions.path\r\n\r\n if (launchOptions.path == this.homePagePath) {\r\n this.checked = true\r\n }\r\n },\r\n },\r\n}\r\n\n```\n\n:::"},"exit":{"name":"## uni.exit(options?) @exit","description":"\r\n退出当前应用","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ExitOptions](#exitoptions-values) | 否 | - | - |\n#### ExitOptions 的属性值 @exitoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (res: [ExitSuccess](#exitsuccess-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (res: [IExitError](#iexiterror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### ExitSuccess 的属性值 @exitsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### IExitError 的属性值 @iexiterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 12001 \\\\| 12002 | 是 | - | 错误码
- 12001: 系统不支持
- 12002: 未知错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"","compatibility":"### exit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.exit)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/exit/exit.uvue) \n ```vue\n\r\n\t\r\n\t\t\r\n\t\r\n\r\n\r\n\r\n\r\n\n```"},"env":{"name":"## env","description":"","param":"### env 的属性值 @env-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| USER_DATA_PATH | string | 是 | - | 应用专属存储空间的外置存储空间根目录下的files目录 |\n| CACHE_PATH | string | 是 | - | 应用专属存储空间的外置存储空间根目录下的cache目录 |\n| SANDBOX_PATH | string | 是 | - | 应用专属存储空间的外置存储空间根目录(caches/files) |\n","compatibility":"#### env 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| USER_DATA_PATH | 3.99 | x | - |\n| CACHE_PATH | 3.99 | x | - |\n| SANDBOX_PATH | 3.99 | x | - |\n","returnValue":"","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.env)\n"},"navigateTo":{"name":"## uni.navigateTo(options) @navigateto","description":"\r\n保留当前页面,跳转到应用内的某个页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [NavigateToOptions](#navigatetooptions-values) | 是 | - | - |\n#### NavigateToOptions 的属性值 @navigatetooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string (string.PageURIString) | 是 | - | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [NavigateToError](#navigatetoerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### NavigateToError 的属性值 @navigatetoerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | 路由错误码 - 4: 框架内部异常 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### NavigateToOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| url | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### navigateTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[navigateTo](http://uniapp.dcloud.io/api/router?id=navigateto)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.navigateTo)\n"},"reLaunch":{"name":"## uni.reLaunch(options) @relaunch","description":"\r\n关闭所有页面,打开到应用内的某个页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ReLaunchOptions](#relaunchoptions-values) | 是 | - | - |\n#### ReLaunchOptions 的属性值 @relaunchoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string (string.PageURIString) | 是 | - | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [ReLaunchError](#relauncherror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### ReLaunchError 的属性值 @relauncherror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### ReLaunchOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| url | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### reLaunch 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[reLaunch](http://uniapp.dcloud.io/api/router?id=relaunch)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.reLaunch)\n"},"navigateBack":{"name":"## uni.navigateBack(options?) @navigateback","description":"\r\n关闭当前页面,返回上一页面或多级页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [NavigateBackOptions](#navigatebackoptions-values) | 否 | - | - |\n#### NavigateBackOptions 的属性值 @navigatebackoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| delta | number | 否 | - | 返回的页面数,如果 delta 大于现有页面数,则返回到首页 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [NavigateBackError](#navigatebackerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### NavigateBackError 的属性值 @navigatebackerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### NavigateBackOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| delta | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### navigateBack 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[navigateBack](http://uniapp.dcloud.io/api/router?id=navigateback)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.navigateBack)\n"},"redirectTo":{"name":"## uni.redirectTo(options) @redirectto","description":"\r\n关闭当前页面,跳转到应用内的某个页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RedirectToOptions](#redirecttooptions-values) | 是 | - | - |\n#### RedirectToOptions 的属性值 @redirecttooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string (string.PageURIString) | 是 | - | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [RedirectToError](#redirecttoerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### RedirectToError 的属性值 @redirecttoerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### RedirectToOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| url | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### redirectTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[redirectTo](http://uniapp.dcloud.io/api/router?id=redirectto)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.redirectTo)\n"},"switchTab":{"name":"## uni.switchTab(options) @switchtab","description":"\r\n跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SwitchTabOptions](#switchtaboptions-values) | 是 | - | - |\n#### SwitchTabOptions 的属性值 @switchtaboptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string (string.PageURIString) | 是 | - | 需要跳转的 tabBar 页面的路径,路径后不能带参数 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SwitchTabError](#switchtaberror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SwitchTabError 的属性值 @switchtaberror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SwitchTabOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| url | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### switchTab 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[switchTab](http://uniapp.dcloud.io/api/router?id=switchtab)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.switchTab)\n"},"navigator":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/navigator/navigator.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/navigator/navigator\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n onLoad触发时间戳:\r\n {{ onLoadTime }}\r\n \r\n \r\n onShow触发时间戳:\r\n {{ onShowTime }}\r\n \r\n \r\n onReady触发时间戳:\r\n {{ onReadyTime }}\r\n \r\n \r\n onHide触发时间戳:\r\n {{ onHideTime }}\r\n \r\n \r\n onBackPress触发时间戳:\r\n 见控制台\r\n \r\n \r\n onUnload触发时间戳:\r\n 见控制台\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n data() {\r\n return {\r\n onLoadTime: 0,\r\n onShowTime: 0,\r\n onReadyTime: 0,\r\n onHideTime: 0,\r\n }\r\n },\r\n onLoad() {\r\n this.onLoadTime = Date.now()\r\n console.log('onLoad', this.onLoadTime)\r\n },\r\n onShow() {\r\n this.onShowTime = Date.now()\r\n console.log('onShow', this.onShowTime)\r\n },\r\n onReady() {\r\n this.onReadyTime = Date.now()\r\n console.log('onReady', this.onReadyTime)\r\n },\r\n onHide() {\r\n this.onHideTime = Date.now()\r\n console.log('onHide', this.onHideTime)\r\n },\r\n onBackPress(options : OnBackPressOptions) : boolean | null {\r\n console.log('onBackPress', Date.now())\r\n console.log('onBackPress from', options.from)\r\n return null\r\n },\r\n onUnload() {\r\n console.log('onUnload', Date.now())\r\n },\r\n methods: {\r\n reLaunch() {\r\n uni.reLaunch({\r\n url: '/pages/tabBar/component',\r\n success(result) {\r\n console.log('reLaunch success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('reLaunch fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('reLaunch complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateTo() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=Hello',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateToErrorPage() {\r\n uni.navigateTo({\r\n url: '/pages/error-page/error-page',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n uni.showToast({\r\n title: error.errMsg,\r\n icon: 'none',\r\n })\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateToDebounce() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=debounce',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=debounce',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath1() {\r\n uni.navigateTo({\r\n url: 'new-page/new-page-1?data=new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath2() {\r\n uni.navigateTo({\r\n url: './new-page/new-page-1?data=./new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath3() {\r\n uni.navigateTo({\r\n url: '../navigator/new-page/new-page-1?data=../navigator/new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateBack() {\r\n uni.navigateBack({\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateBackWithDelta1() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1',\r\n success() {\r\n uni.navigateBack({\r\n delta: 1,\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n })\r\n },\r\n navigateBackWithDelta100() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1',\r\n success() {\r\n uni.navigateBack({\r\n delta: 100,\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n })\r\n },\r\n redirectTo() {\r\n uni.redirectTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=Hello',\r\n success(result) {\r\n console.log('redirectTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('redirectTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('redirectTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n switchTab() {\r\n uni.switchTab({\r\n url: '/pages/tabBar/template',\r\n success(result) {\r\n console.log('switchTab success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('switchTab fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('switchTab complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"setNavigationBarColor":{"name":"## uni.setNavigationBarColor(options) @setnavigationbarcolor","description":"\r\n设置导航条、状态栏颜色\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetNavigationBarColorOptions](#setnavigationbarcoloroptions-values) | 是 | - | - |\n#### SetNavigationBarColorOptions 的属性值 @setnavigationbarcoloroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| frontColor | \"#ffffff\" \\\\| \"#000000\" | 是 | - | 前景颜色值,包括按钮、标题、状态栏的颜色,仅支持 #ffffff 和 #000000 |\n| backgroundColor | string | 是 | - | 背景颜色值,有效值为十六进制颜色 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (error: [SetNavigationBarColorError](#setnavigationbarcolorerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetNavigationBarColorError 的属性值 @setnavigationbarcolorerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetNavigationBarColorOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| frontColor | √ | x | 4.0 |\n| backgroundColor | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### setNavigationBarColor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[setNavigationBarColor](https://doc.dcloud.net.cn/uni-app-x/api/set-navigation-bar-color.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-navigation-bar-color)\n"},"set-navigation-bar-color":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/set-navigation-bar-color/set-navigation-bar-color.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/set-navigation-bar-color/set-navigation-bar-color\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n methods: {\r\n setNavigationBarColor1() {\r\n uni.setNavigationBarColor({\r\n frontColor: '#ffffff',\r\n backgroundColor: '#00ff00',\r\n success: () => {\r\n console.log('setNavigationBarColor success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarColor fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarColor complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n setNavigationBarColor2() {\r\n uni.setNavigationBarColor({\r\n frontColor: '#000000',\r\n backgroundColor: '#ff0000',\r\n success: () => {\r\n console.log('setNavigationBarColor success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarColor fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarColor complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n },\r\n goCustomNavigation() {\r\n uni.navigateTo({\r\n url: '/pages/template/navbar-lite/navbar-lite'\r\n })\r\n }\r\n },\r\n }\r\n\n```\n\n:::"},"setNavigationBarTitle":{"name":"## uni.setNavigationBarTitle(options) @setnavigationbartitle","description":"\r\n动态设置当前页面的标题\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetNavigationBarTitleOptions](#setnavigationbartitleoptions-values) | 是 | - | - |\n#### SetNavigationBarTitleOptions 的属性值 @setnavigationbartitleoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 是 | - | 页面标题 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (error: [SetNavigationBarTitleError](#setnavigationbartitleerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetNavigationBarTitleError 的属性值 @setnavigationbartitleerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetNavigationBarTitleOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| title | 3.97 | x | 4.0 |\n| success | 3.97 | x | 4.0 |\n| fail | 3.97 | x | 4.0 |\n| complete | 3.97 | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### setNavigationBarTitle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | x | 4.0 |\n","tutorial":"\n### 参见\n[setNavigationBarTitle](https://doc.dcloud.net.cn/uni-app-x/api/set-navigation-bar-title.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-navigation-bar-title)\n"},"set-navigation-bar-title":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/set-navigation-bar-title/set-navigation-bar-title.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/set-navigation-bar-title/set-navigation-bar-title\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n data() {\r\n return {\r\n newTitle: 'new title',\r\n longTitle: 'long title long title long title long title long title long title long title long title long title long title'\r\n }\r\n },\r\n methods: {\r\n setNavigationBarNewTitle() {\r\n uni.setNavigationBarTitle({\r\n title: this.newTitle,\r\n success: () => {\r\n console.log('setNavigationBarTitle success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarTitle fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarTitle complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n setNavigationBarLongTitle() {\r\n uni.setNavigationBarTitle({\r\n title: this.longTitle,\r\n success() {\r\n console.log('setNavigationBarTitle success')\r\n },\r\n fail() {\r\n console.log('setNavigationBarTitle fail')\r\n },\r\n complete() {\r\n console.log('setNavigationBarTitle complete')\r\n }\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n }\r\n },\r\n }\r\n\n```\n\n:::"},"showTabBar":{"name":"## uni.showTabBar(options?) @showtabbar","description":"\r\n显示 tabBar\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowTabBarOptions](#showtabbaroptions-values) | 否 | - | - |\n#### ShowTabBarOptions 的属性值 @showtabbaroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| animation | boolean | 否 | - | 是否需要动画效果 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\\\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### showTabBar 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[showTabBar](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#showtabbar)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.showTabBar)\n"},"hideTabBar":{"name":"## uni.hideTabBar(options?) @hidetabbar","description":"\r\n隐藏 tabBar\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [HideTabBarOptions](#hidetabbaroptions-values) | 否 | - | - |\n#### HideTabBarOptions 的属性值 @hidetabbaroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| animation | boolean | 否 | - | 是否需要动画效果 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\\\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### hideTabBar 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[hideTabBar](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#hidetabbar)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.hideTabBar)\n"},"showTabBarRedDot":{"name":"## uni.showTabBarRedDot(options) @showtabbarreddot","description":"\r\n显示 tabBar 某一项的右上角的红点\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowTabBarRedDotOptions](#showtabbarreddotoptions-values) | 是 | - | - |\n#### ShowTabBarRedDotOptions 的属性值 @showtabbarreddotoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar的哪一项,从左边算起,索引从0开始 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\\\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### showTabBarRedDot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[showTabBarRedDot](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#showtabbarreddot)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.showTabBarRedDot)\n"},"hideTabBarRedDot":{"name":"## uni.hideTabBarRedDot(options) @hidetabbarreddot","description":"\r\n隐藏 tabBar 某一项的右上角的红点\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [HideTabBarRedDotOptions](#hidetabbarreddotoptions-values) | 是 | - | - |\n#### HideTabBarRedDotOptions 的属性值 @hidetabbarreddotoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar的哪一项,从左边算起,索引从0开始 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\\\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### hideTabBarRedDot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[hideTabBarRedDot](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#hidetabbarreddot)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.hideTabBarRedDot)\n"},"setTabBarBadge":{"name":"## uni.setTabBarBadge(options) @settabbarbadge","description":"\r\n为 tabBar 某一项的右上角添加文本\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetTabBarBadgeOptions](#settabbarbadgeoptions-values) | 是 | - | - |\n#### SetTabBarBadgeOptions 的属性值 @settabbarbadgeoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar的哪一项,从左边算起,索引从0开始 |\n| text | string | 是 | - | 显示的文本,不超过 3 个半角字符 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\\\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### setTabBarBadge 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[setTabBarBadge](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbarbadge)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarBadge)\n"},"removeTabBarBadge":{"name":"## uni.removeTabBarBadge(options) @removetabbarbadge","description":"\r\n移除 tabBar 某一项右上角的文本\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RemoveTabBarBadgeOptions](#removetabbarbadgeoptions-values) | 是 | - | - |\n#### RemoveTabBarBadgeOptions 的属性值 @removetabbarbadgeoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar的哪一项,从左边算起,索引从0开始 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\\\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### removeTabBarBadge 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[removeTabBarBadge](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#removetabbarbadge)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.removeTabBarBadge)\n"},"setTabBarStyle":{"name":"## uni.setTabBarStyle(options) @settabbarstyle","description":"\r\n动态设置 tabBar 的整体样式\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetTabBarStyleOptions](#settabbarstyleoptions-values) | 是 | - | - |\n#### SetTabBarStyleOptions 的属性值 @settabbarstyleoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| color | string (string.ColorString) | 否 | - | tab 上的文字默认颜色 |\n| selectedColor | string (string.ColorString) | 否 | - | tab 上的文字选中时的颜色 |\n| backgroundColor | string (string.ColorString) | 否 | - | tab 的背景色 |\n| backgroundImage | string | 否 | - | 图片背景 |\n| backgroundRepeat | \"repeat\" \\\\| \"repeat-x\" \\\\| \"repeat-y\" \\\\| \"no-repeat\" | 否 | - | 背景图平铺方式
- repeat: 背景图片在垂直方向和水平方向平铺
- repeat-x: 背景图片在水平方向平铺,垂直方向拉伸
- repeat-y: 背景图片在垂直方向平铺,水平方向拉伸
- no-repeat: 背景图片在垂直方向和水平方向都拉伸 |\n| borderStyle | string | 否 | - | tabbar上边框的颜色 |\n| midButton | [MidButtonOptions](#midbuttonoptions-values) | 否 | - | tabbar 中间按钮 仅在 list 项为偶数时有效 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### MidButtonOptions 的属性值 @midbuttonoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| width | string | 否 | - | 中间按钮的宽度,tabBar 其它项为减去此宽度后平分,默认值为与其它项平分宽度。默认 80px |\n| height | string | 否 | - | 中间按钮的高度,可以大于 tabBar 高度,达到中间凸起的效果。默认 50px |\n| text | string | 否 | - | 中间按钮的文字 |\n| iconPath | string | 否 | - | 中间按钮的图片路径 |\n| iconWidth | string | 否 | - | 图片宽度(高度等比例缩放)。默认 24px |\n| backgroundImage | string | 否 | - | 中间按钮的背景图片路径 |\n| iconfont | [MidButtonIconFont](#midbuttoniconfont-values) | 否 | - | 字体图标,优先级高于 iconPath |\n\n###### MidButtonIconFont 的属性值 @midbuttoniconfont-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| text | string | 否 | - | 字库 Unicode 码 |\n| selectedText | string | 否 | - | 选中后字库 Unicode 码 |\n| fontSize | string | 否 | - | 字体图标字号(px) |\n| color | string | 否 | - | 字体图标颜色 |\n| selectedColor | string | 否 | - | 字体图标选中颜色 |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\\\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### setTabBarStyle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[setTabBarStyle](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbarstyle)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarStyle)\n"},"setTabBarItem":{"name":"## uni.setTabBarItem(options) @settabbaritem","description":"\r\n动态设置 tabBar 某一项的内容\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetTabBarItemOptions](#settabbaritemoptions-values) | 是 | - | - |\n#### SetTabBarItemOptions 的属性值 @settabbaritemoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar 的哪一项,从左边算起,索引从0开始 |\n| text | string | 否 | - | tab 上按钮文字 |\n| iconPath | string | 否 | - | 图片路径 |\n| selectedIconPath | string | 否 | - | 选中时的图片路径 |\n| pagePath | string | 否 | - | 页面绝对路径 |\n| iconfont | [SetTabBarItemIconFontOptions](#settabbaritemiconfontoptions-values) | 否 | - | 字体图标,优先级高于 iconPath |\n| visible | boolean | 否 | - | tab 是否显示 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetTabBarItemIconFontOptions 的属性值 @settabbaritemiconfontoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| text | string | 是 | - | 字库 Unicode 码 |\n| selectedText | string | 是 | - | 选中后字库 Unicode 码 |\n| fontSize | string | 否 | - | 字体图标字号(px) |\n| color | string | 否 | - | 字体图标颜色 |\n| selectedColor | string | 否 | - | 字体图标选中颜色 |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\\\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### setTabBarItem 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[setTabBarItem](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbaritem)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarItem)\n"},"startPullDownRefresh":{"name":"## uni.startPullDownRefresh(options?) @startpulldownrefresh","description":"\r\n开始下拉刷新\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [StartPullDownRefreshOptions](#startpulldownrefreshoptions-values) | 否 | - | - |\n#### StartPullDownRefreshOptions 的属性值 @startpulldownrefreshoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [PullDownRefreshError](#pulldownrefresherror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### PullDownRefreshError 的属性值 @pulldownrefresherror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### startPullDownRefresh 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[startPullDownRefresh](https://uniapp.dcloud.io/uni-app-x/api/pull-down-refresh.html#startpulldownrefresh)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.pull-down-refresh.startPullDownRefresh)\n"},"stopPullDownRefresh":{"name":"## uni.stopPullDownRefresh() @stoppulldownrefresh","description":"\r\n停止当前页面下拉刷新\r\n","param":"","returnValue":"","compatibility":"### stopPullDownRefresh 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[stopPullDownRefresh](https://doc.dcloud.net.cn/uni-app-x/api/pull-down-refresh.html#stoppulldownrefresh)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.pull-down-refresh.stopPullDownRefresh)\n"},"pull-down-refresh":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/pull-down-refresh/pull-down-refresh.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/pull-down-refresh/pull-down-refresh\n>Template\n```vue\n\r\n\t\r\n\t\t\r\n\t\t\r\n\t\t\tlist - {{num}}\r\n\t\t\t{{loadMoreText}}\r\n\t\t\r\n\t\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n\texport default {\r\n\t\tdata() {\r\n\t\t\treturn {\r\n\t\t\t\tdata: [] as Array,\r\n\t\t\t\tloadMoreText: \"加载中...\",\r\n\t\t\t\tshowLoadMore: false,\r\n\t\t\t\tmax: 0\r\n\t\t\t}\r\n\t\t},\r\n\t\tonLoad() {\r\n\t\t\tthis.initData();\r\n\t\t},\r\n\t\tonReachBottom() {\r\n\t\t\tconsole.log(\"onReachBottom\");\r\n\t\t\tif (this.max > 40) {\r\n\t\t\t\tthis.loadMoreText = \"没有更多数据了!\"\r\n\t\t\t\treturn;\r\n\t\t\t}\r\n\t\t\tthis.showLoadMore = true;\r\n\t\t\tsetTimeout(() => {\r\n\t\t\t\tthis.setListData();\r\n\t\t\t}, 300);\r\n\t\t},\r\n\t\tonPullDownRefresh() {\r\n\t\t\tconsole.log('onPullDownRefresh');\r\n\t\t\tthis.initData();\r\n\t\t},\r\n\t\tmethods: {\r\n\t\t\tinitData(){\r\n\t\t\t\tsetTimeout(() => {\r\n\t\t\t\t\tthis.max = 0;\r\n\t\t\t\t\tthis.data = [];\r\n\t\t\t\t\tlet data:Array = [];\r\n\t\t\t\t\tthis.max += 20;\r\n\t\t\t\t\tfor (let i:number = this.max - 19; i < this.max + 1; i++) {\r\n\t\t\t\t\t\tdata.push(i)\r\n\t\t\t\t\t}\r\n\t\t\t\t\tthis.data = this.data.concat(data);\r\n\t\t\t\t\tuni.stopPullDownRefresh();\r\n\t\t\t\t}, 300);\r\n\t\t\t},\r\n\t\t\tsetListData() {\r\n\t\t\t\tlet data:Array = [];\r\n\t\t\t\tthis.max += 10;\r\n\t\t\t\tfor (let i:number = this.max - 9; i < this.max + 1; i++) {\r\n\t\t\t\t\tdata.push(i)\r\n\t\t\t\t}\r\n\t\t\t\tthis.data = this.data.concat(data);\r\n\t\t\t}\r\n\t\t}\r\n\t}\r\n\n```\n\n:::"},"pageScrollTo":{"name":"## uni.pageScrollTo(options) @pagescrollto","description":"\r\n将页面滚动到目标位置\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [PageScrollToOptions](#pagescrolltooptions-values) | 是 | - | - |\n#### PageScrollToOptions 的属性值 @pagescrolltooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| scrollTop | number | 否 | - | 滚动到页面的目标位置 |\n| selector | string | 否 | - | 选择器 |\n| offsetTop | number | 否 | - | 偏移距离,可以滚动到 selector 加偏移距离的位置 |\n| duration | number | 否 | - | 滚动动画的时长 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [PageScrollToError](#pagescrolltoerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### PageScrollToError 的属性值 @pagescrolltoerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### PageScrollToOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| offsetTop | 3.91 | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### pageScrollTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[pageScrollTo](https://doc.dcloud.net.cn/uni-app-x/api/page-scroll-to.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.page-scroll-to)\n"},"page-scroll-to":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/page-scroll-to/page-scroll-to.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/page-scroll-to/page-scroll-to\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{ index }}\r\n \r\n scrollTo-custom-element\r\n \r\n {{ index2 }}\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'pageScrollTo',\r\n }\r\n },\r\n methods: {\r\n scrollTo() {\r\n uni.pageScrollTo({\r\n scrollTop: 100,\r\n duration: 300,\r\n success: () => {\r\n console.log('success')\r\n },\r\n })\r\n },\r\n scrollToElement() {\r\n uni.pageScrollTo({\r\n selector: '.custom-element',\r\n duration: 300,\r\n success: () => {\r\n console.log('success')\r\n },\r\n })\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"getElementById":{"name":"## uni.getElementById(id) @getelementbyid","description":"\r\n返回一个匹配特定 ID 的元素, 如果不存在,返回 null。\\\r\n如果需要获取指定的节点类型,需要使用 as 进行类型转换。\\\r\nID 区分大小写,且应该是唯一的。如果存在多个匹配的元素,则返回第一个匹配的元素。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| id | string.IDString \\\\| string | 是 | - | - |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) | 否 | \n","compatibility":"### getElementById 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[getElementById](https://doc.dcloud.net.cn/uni-app-x/api/get-element.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.dom.get-element.getElementById)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-element-by-id/get-element-by-id.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-element-by-id/get-element-by-id\n>Template\n```vue\n\r\n \r\n \r\n this is text\r\n this is view\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n checked: false,\r\n homePagePath: '/pages/tabBar/component',\r\n launchOptionsPath: '',\r\n }\r\n },\r\n methods: {\r\n getElementByNotExistId() : Element | null {\r\n return uni.getElementById('not-exist-id')\r\n },\r\n changePageHeadBackgroundColor() {\r\n const pageHead = uni.getElementById('page-head')!\r\n pageHead.style.setProperty('background-color', 'red')\r\n },\r\n changeTextColor() {\r\n const text = uni.getElementById('text')!\r\n text.style.setProperty('color', 'red')\r\n },\r\n changeViewStyle() {\r\n const view = uni.getElementById('view')\r\n if (view !== null) {\r\n view.style.setProperty('width', '90%')\r\n view.style.setProperty('height', '50px')\r\n view.style.setProperty('background-color', '#007AFF')\r\n }\r\n },\r\n goMultipleRootNode() {\r\n uni.navigateTo({ url: '/pages/API/get-element-by-id/get-element-by-id-multiple-root-node' })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"createSelectorQuery":{"name":"## uni.createSelectorQuery() @createselectorquery","description":"\r\n返回一个SelectorQuery对象实例\r\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n#### SelectorQuery 的方法 @selectorquery-values \n\n#### in(component?) @in\n\r\n将选择器的选取范围更改为自定义组件component内\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| component | any | 否 | - | - |\n##### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n#### select(selector) @select\n\r\n在当前页面下选择第一个匹配选择器selector的节点\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| selector | string | 是 | - | - |\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) | \n\n###### NodesRef 的方法 @nodesref-values \n\n##### boundingClientRect(callback?) @boundingclientrect\n\r\n添加节点的布局位置的查询请求,相对于显示区域,以像素为单位\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 否 | - | - |\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n##### scrollOffset(callback) @scrolloffset\n\r\n添加节点的滚动位置查询请求,以像素为单位\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | |\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n##### fields(fields, callback) @fields\n\r\n获取节点的相关信息,需要获取的字段在fields中指定\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fields | [NodeField](#nodefield-values) | 是 | - | - |\n| callback | (result: any) => void | 是 | - | |\n###### NodeField 的属性值 @nodefield-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| id | boolean | 否 | - | 是否返回节点 id |\n| dataset | boolean | 否 | - | 是否返回节点 dataset |\n| rect | boolean | 否 | - | 是否返回节点布局位置(left right top bottom) |\n| size | boolean | 否 | - | 是否返回节点尺寸(width height) |\n| scrollOffset | boolean | 否 | - | 是否返回节点的 scrollLeft scrollTop,节点必须是 scroll-view 或者 viewport |\n| properties | Array\\ | 否 | - | 指定属性名列表,返回节点对应属性名的当前属性值(只能获得组件文档中标注的常规属性值,id class style 和事件绑定的属性值不可获取) |\n| computedStyle | Array\\ | 否 | - | 指定样式名列表,返回节点对应样式名的当前值 |\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n##### node(callback) @node\n\r\n获取 Node 节点实例。目前支持 Canvas 的获取。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n\n\n#### selectAll(selector) @selectall\n\r\n在当前页面下选择匹配选择器selector的所有节点\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| selector | string | 是 | - | - |\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) | \n\n\n\n#### selectViewport() @selectviewport\n\r\n选择显示区域\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) | \n\n\n\n#### exec(callback) @exec\n\r\n执行所有的请求\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: Array\\) => void | 是 | - | - |\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [NodesRef](#nodesref-values) | 否 | \n\n\n","compatibility":"### createSelectorQuery 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[createSelectorQuery](https://doc.dcloud.net.cn/uni-app-x/api/nodes-info.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.dom.nodes-info.createSelectorQuery)\n"},"nodes-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/nodes-info/nodes-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/nodes-info/nodes-info\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n left: \r\n {{nodeInfo.left}}\r\n \r\n \r\n top: \r\n {{nodeInfo.top}}\r\n \r\n \r\n right: \r\n {{nodeInfo.right}}\r\n \r\n \r\n bottom: \r\n {{nodeInfo.bottom}}\r\n \r\n \r\n width: \r\n {{nodeInfo.width}}\r\n \r\n \r\n height: \r\n {{nodeInfo.height}}\r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type NodeInfoType = {\r\n left : number | null,\r\n top : number | null,\r\n right : number | null,\r\n bottom : number | null,\r\n width : number | null,\r\n height : number | null,\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'createSelectorQuery',\r\n nodeInfoList: [] as NodeInfoType[],\r\n //供自动化测试使用\r\n // resizeRectValid: false\r\n }\r\n },\r\n onResize() {\r\n //供自动化测试使用\r\n /* var rect12Element = uni.getElementById(\"rect-1-2\")\r\n if(rect12Element != null) {\r\n var domRect = rect12Element.getBoundingClientRect()\r\n if(domRect.width > 100) {\r\n this.resizeRectValid = true\r\n }\r\n } */\r\n },\r\n methods: {\r\n getNodeInfo() {\r\n uni.createSelectorQuery().select('.rect1').boundingClientRect().exec((ret) => {\r\n this.nodeInfoList.length = 0\r\n const i = ret[0] as NodeInfo\r\n this.nodeInfoList.push({\r\n left: i.left,\r\n top: i.top,\r\n right: i.right,\r\n bottom: i.bottom,\r\n width: i.width,\r\n height: i.height,\r\n } as NodeInfoType)\r\n })\r\n },\r\n getAllNodeInfo() {\r\n uni.createSelectorQuery().selectAll('.rect').boundingClientRect().exec((ret) => {\r\n this.nodeInfoList.length = 0\r\n const array = ret[0] as NodeInfo[]\r\n array.forEach((i) => {\r\n this.nodeInfoList.push({\r\n left: i.left,\r\n top: i.top,\r\n right: i.right,\r\n bottom: i.bottom,\r\n width: i.width,\r\n height: i.height,\r\n } as NodeInfoType)\r\n })\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"showActionSheet":{"name":"## uni.showActionSheet(options) @showactionsheet","description":"从底部向上弹出操作菜单","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowActionSheetOptions](#showactionsheetoptions-values) | 是 | - | uni.showActionSheet函数参数定义 |\n#### ShowActionSheetOptions 的属性值 @showactionsheetoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 否 | - | 菜单标题 |\n| alertText | string | 否 | - | 警示文案(同菜单标题, app无效) |\n| itemList | Array\\ | 是 | - | 按钮的文字数组 |\n| itemColor | string.ColorString | 否 | - | 按钮的文字颜色,字符串格式(iOS默认为系统控件颜色) |\n| success | (res: [ShowActionSheetSuccess](#showactionsheetsuccess-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### ShowActionSheetSuccess 的属性值 @showactionsheetsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| tapIndex | number | 否 | - | 用户点击的按钮,从上到下的顺序,从0开始 |\n","returnValue":"","compatibility":"### showActionSheet 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[showActionSheet]([](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showActionSheet)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/action-sheet/action-sheet.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/action-sheet/action-sheet\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n {{item.name}}\r\n \r\n \r\n \r\n \r\n \r\n 自定义itemColor\r\n \r\n \r\n \r\n 超长文本和空文本item\r\n \r\n \r\n \r\n 超过6个item\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'action-sheet',\r\n itemColorCustom: false,\r\n itemContentLarge: false,\r\n itemNumLargeSelect: false,\r\n items: [{\r\n value: '标题',\r\n name: '有标题'\r\n },\r\n {\r\n value: '',\r\n name: '无标题'\r\n },\r\n {\r\n value: '超长标题测试内容,测试超过显示最大范围之后的样式-超长标题测试内容,测试超过显示最大范围之后的样式',\r\n name: '超长标题'\r\n }\r\n ] as ItemType[],\r\n current: 0,\r\n }\r\n },\n onLoad(){\n uni.showActionSheet({\n title: \"onLoad 调用示例,请手动取消\",\n itemList:['item1', 'item2'],\n })\n },\r\n methods: {\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n for (let i = 0; i < this.items.length; i++) {\r\n if (this.items[i].value === e.detail.value) {\r\n this.current = i;\r\n break;\r\n }\r\n }\r\n },\r\n itemContentLargeChange: function (e : UniSwitchChangeEvent) {\r\n this.itemContentLarge = e.detail.value\r\n },\r\n itemColorChange: function (e : UniSwitchChangeEvent) {\r\n this.itemColorCustom = e.detail.value\r\n },\r\n itemNumLargeChange: function (e : UniSwitchChangeEvent) {\r\n this.itemNumLargeSelect = e.detail.value\r\n },\r\n actionSheetTap() {\r\n\r\n let itemInfo = ['item1', 'item2', 'item3', 'item4']\r\n\r\n if (this.itemContentLarge) {\r\n itemInfo = ['两个黄鹂鸣翠柳,一行白鹭上青天。窗含西岭千秋雪,门泊东吴万里船', '水光潋滟晴方好,山色空蒙雨亦奇。 欲把西湖比西子,淡妆浓抹总相宜', '']\r\n }\n\n if (this.itemNumLargeSelect) {\r\n // 大量选项测试,不能超过6个元素 https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet\r\n itemInfo = []\n for (var i = 1; i <= 10; i++) {\r\n itemInfo.push('两个黄鹂鸣翠柳,一行白鹭上青天');\r\n }\r\n }\r\n\r\n const that = this\r\n if (this.itemColorCustom) {\r\n uni.showActionSheet({\r\n title: this.items[this.current].value,\r\n itemList: itemInfo,\r\n itemColor: \"#ff00ff\",\r\n success: (e) => {\r\n console.log(e.tapIndex);\r\n uni.showToast({\r\n title: \"点击了第\" + e.tapIndex + \"个选项\",\r\n icon: \"none\"\r\n })\r\n },\r\n fail: (e) => {\r\n console.log(e);\r\n }\r\n })\r\n } else {\r\n uni.showActionSheet({\r\n title: this.items[this.current].value,\r\n itemList: itemInfo,\r\n success: (e) => {\r\n console.log(e.tapIndex);\r\n uni.showToast({\r\n title: \"点击了第\" + e.tapIndex + \"个选项\",\r\n icon: \"none\"\r\n })\r\n },\r\n fail: (e) => {\r\n console.log(e);\r\n uni.showToast({\r\n title: e.errMsg,\r\n icon: \"none\"\r\n })\r\n }\r\n })\r\n }\r\n },\r\n }\r\n }\r\n\n```\n\n:::"},"showLoading":{"name":"## uni.showLoading(options) @showloading","description":"显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowLoadingOptions](#showloadingoptions-values) | 是 | - | uni.showLoading参数定义 |\n#### ShowLoadingOptions 的属性值 @showloadingoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 是 | - | 提示的内容,长度与 icon 取值有关。 |\n| mask | boolean | 否 | - | 是否显示透明蒙层,防止触摸穿透,默认:false |\n| success | (res: ShowLoadingSuccess) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n","returnValue":"","compatibility":"### showLoading 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[showLoading]([](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showloading))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showLoading)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/loading/loading.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/loading/loading\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n 是否显示透明蒙层-屏蔽点击事件\r\n \r\n \r\n \r\n \r\n 设置标题 \r\n \r\n \r\n \r\n \r\n \r\n {{ item.name }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 为方便演示,loading弹出3秒后自动关闭\r\n \r\n \r\n \r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string\r\n name : string\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'loading',\r\n items: [\r\n {\r\n value: 'null',\r\n name: '无标题',\r\n },\r\n {\r\n value: '三秒后自动关闭',\r\n name: '普通标题',\r\n },\r\n {\r\n value: '超长文本内容,测试超出范围-超长文本内容,测试超出范围-三秒后自动关闭',\r\n name: '长标题',\r\n },\r\n ] as ItemType[],\r\n current: 0,\r\n maskSelect: false,\r\n titleSelect: \"null\"\r\n }\r\n },\r\n onLoad(){\r\n uni.showLoading({\r\n \ttitle:'onLoad 调用示例,2秒后消失'\r\n })\r\n setTimeout(function() {\r\n uni.hideLoading()\r\n }, 2000);\r\n },\r\n methods: {\r\n\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n const selected = this.items.find((item) : boolean => {\r\n return item.value == e.detail.value\r\n })\r\n if (selected != null) {\r\n this.titleSelect = selected.value\r\n }\r\n },\r\n maskChange: function (e : UniSwitchChangeEvent) {\r\n this.maskSelect = e.detail.value\r\n },\r\n showLoading: function () {\r\n\r\n console.log(this.titleSelect)\r\n if (this.titleSelect == \"null\") {\r\n uni.showLoading({\r\n title: \"\",\r\n mask: this.maskSelect\r\n });\r\n } else {\r\n uni.showLoading({\r\n title: this.titleSelect,\r\n mask: this.maskSelect\r\n });\r\n }\r\n setTimeout(() => {\r\n this.hideLoading();\r\n }, 3000);\r\n },\r\n hideLoading: function () {\r\n uni.hideLoading();\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"showModal":{"name":"## uni.showModal(options) @showmodal","description":"显示模态弹窗,可以只有一个确定按钮,也可以同时有确定和取消按钮。类似于一个API整合了 html 中:alert、confirm。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowModalOptions](#showmodaloptions-values) | 是 | - | uni.showModal 参数定义 |\n#### ShowModalOptions 的属性值 @showmodaloptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 否 | - | 提示的标题 |\n| content | string | 否 | - | 提示的内容 |\n| showCancel | boolean | 否 | true
是否显示取消按钮,默认为 true | |\n| cancelText | string | 否 | - | 取消按钮的文字,默认为\"取消\" |\n| cancelColor | string.ColorString | 否 | - | 取消按钮的文字颜色,默认为\"#000000\" |\n| confirmText | string | 否 | - | 确定按钮的文字,默认为\"确定\" |\n| confirmColor | string.ColorString | 否 | - | 确定按钮的文字颜色 |\n| editable | boolean | 否 | false
是否显示输入框 | |\n| placeholderText | string | 否 | - | 显示输入框时的提示文本 |\n| success | (res: [ShowModalSuccess](#showmodalsuccess-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### ShowModalSuccess 的属性值 @showmodalsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| confirm | boolean | 是 | - | 为 true 时,表示用户点击了确定按钮 |\n| cancel | boolean | 是 | - | 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭) |\n| content | string | 否 | - | editable 为 true 时,用户输入的文本 |\n","returnValue":"","compatibility":"### showModal 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[showModal]([](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showmodal))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showModal)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/modal/modal.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/modal/modal\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{ item.name }}\r\n \r\n \r\n \r\n \r\n \r\n 是否显示取消按钮\r\n \r\n \r\n \r\n 定制取消文案\r\n \r\n \r\n \r\n 定制确认文案\r\n \r\n \r\n \r\n 是否显示输入框\r\n \r\n \r\n \r\n 是否定制输入提示词\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{ exeRet }}\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'modal',\r\n showCancelSelect: false,\r\n cancelTextSelect: false,\r\n confirmTextSelect: false,\r\n editableSelect: false,\r\n placeholderTextSelect: false,\r\n exeRet: \"\",\r\n items: [{\r\n value: '标题',\r\n name: '有标题'\r\n },\r\n {\r\n value: '',\r\n name: '无标题'\r\n },\r\n {\r\n value: '超长标题测试内容,测试超过显示最大范围之后的样式-超长标题测试内容,测试超过显示最大范围之后的样式',\r\n name: '超长标题'\r\n }\r\n ] as ItemType[],\r\n current: 0\r\n }\r\n },\r\n onLoad() {\r\n uni.showModal({\r\n title: \"onLoad 调用示例,请手动取消\",\r\n showCancel: false\r\n })\r\n },\r\n methods: {\r\n showCancelChange: function (e : UniSwitchChangeEvent) {\r\n this.showCancelSelect = e.detail.value\r\n },\r\n cancelTextChange: function (e : UniSwitchChangeEvent) {\r\n this.cancelTextSelect = e.detail.value\r\n },\r\n confirmTextChange: function (e : UniSwitchChangeEvent) {\r\n this.confirmTextSelect = e.detail.value\r\n },\r\n editableChange: function (e : UniSwitchChangeEvent) {\r\n this.editableSelect = e.detail.value\r\n },\r\n placeholderTextChange: function (e : UniSwitchChangeEvent) {\r\n this.placeholderTextSelect = e.detail.value\r\n },\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n for (let i = 0; i < this.items.length; i++) {\r\n if (this.items[i].value === e.detail.value) {\r\n this.current = i;\r\n break;\r\n }\r\n }\r\n },\r\n modalTap: function () {\r\n let cancelTextVal : string\r\n let cancelColorVal = ''\r\n if (this.cancelTextSelect) {\r\n cancelTextVal = \"修改后的取消文本\"\r\n cancelColorVal = \"#ff00ff\"\r\n } else {\r\n cancelTextVal = \"取消\"\r\n }\r\n\r\n let confirmTextVal = '确定'\r\n let confirmColorVal = ''\r\n if (this.confirmTextSelect) {\r\n confirmTextVal = \"修改后的确定文本\"\r\n confirmColorVal = \"#00ffff\"\r\n }\r\n\r\n let placeholderTextVal = ''\r\n let contentVal = \"弹窗内容,告知当前状态、信息和解决方法,描述文字尽量控制在三行内\"\r\n if (this.placeholderTextSelect) {\r\n placeholderTextVal = \"定制提示信息\"\r\n contentVal = \"\"\r\n }\r\n uni.showModal({\r\n title: this.items[this.current].value,\r\n editable: this.editableSelect,\r\n placeholderText: placeholderTextVal,\r\n content: contentVal,\r\n showCancel: this.showCancelSelect,\r\n cancelText: cancelTextVal,\r\n cancelColor: cancelColorVal,\r\n confirmText: confirmTextVal,\r\n confirmColor: confirmColorVal,\r\n success: (res) => {\r\n this.exeRet = JSON.stringify(res)\r\n },\r\n fail: (res) => {\r\n this.exeRet = JSON.stringify(res)\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"showToast":{"name":"## uni.showToast(options) @showtoast","description":"显示消息提示框","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowToastOptions](#showtoastoptions-values) | 是 | - | uni.showToast参数定义 |\n#### ShowToastOptions 的属性值 @showtoastoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 是 | - | 提示的内容,长度与 icon 取值有关。 |\n| icon | \"success\" \\\\| \"error\" \\\\| \"loading\" \\\\| \"none\" | 否 | - | icon值说明 success: 显示成功图标,error: 显示错误图标; loading: 显示加载图标;none: 不显示图标。 |\n| image | string.ImageURIString | 否 | - | 自定义图标的本地路径(app端暂不支持gif) |\n| mask | boolean | 否 | - | 是否显示透明蒙层,防止触摸穿透,默认:false |\n| duration | number | 否 | - | 提示的延迟时间,单位毫秒,默认:1500 |\n| position | \"top\" \\\\| \"center\" \\\\| \"bottom\" | 否 | - | position值说明(仅App生效) top: 居上显示; center: 居中显示;bottom: 居底显示 |\n| success | (res: ShowToastSuccess) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n","returnValue":"","compatibility":"### showToast 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[showToast]([](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showtoast))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showToast)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/toast/toast.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/toast/toast\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{exeRet}}\r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'toast',\r\n exeRet: ''\r\n }\r\n },\r\n onLoad() {\r\n uni.showToast({\r\n title: 'onLoad 调用示例,2秒后消失'\r\n })\r\n setTimeout(function () {\r\n uni.hideToast()\r\n }, 2000);\r\n },\r\n methods: {\r\n toast1Tap: function () {\r\n uni.showToast({\r\n title: \"默认\",\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n toastTapIconError: function () {\r\n uni.showToast({\r\n title: \"默认\",\r\n icon: 'error',\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n toast2Tap: function () {\r\n uni.showToast({\r\n title: \"duration 3000\",\r\n duration: 3000,\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n toast3Tap: function () {\r\n uni.showToast({\r\n title: \"loading\",\r\n icon: \"loading\",\r\n duration: 5000,\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n toast4Tap: function () {\r\n uni.showToast({\r\n title: \"logo\",\r\n image: \"/static/uni.png\",\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n // #ifdef APP-PLUS\r\n toast5Tap: function () {\r\n uni.showToast({\r\n title: \"显示一段轻提示\",\r\n position: 'bottom',\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n // #endif\r\n hideToast: function () {\r\n uni.hideToast()\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"loadFontFace":{"name":"## uni.loadFontFace(options) @loadfontface","description":"\r\n动态加载网络字体\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [LoadFontFaceOptions](#loadfontfaceoptions-values) | 是 | - | - |\n#### LoadFontFaceOptions 的属性值 @loadfontfaceoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| global | boolean | 否 | - | 是否全局生效。微信小程序 '2.10.0'起支持全局生效,需在 app.vue 中调用。 |\n| family | string | 是 | - | 定义的字体名称 |\n| source | string | 是 | - | 字体资源的地址 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (error: [LoadFontFaceError](#loadfontfaceerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### LoadFontFaceError 的属性值 @loadfontfaceerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 4 \\\\| 99 \\\\| 101 \\\\| 100001 \\\\| 100002 \\\\| 200001 \\\\| 300001 \\\\| 300002 | 是 | - | 错误码
- 4: 框架内部异常
- 99: page is not ready
- 101: 参数错误
- 100001: family is null
- 100002: source is null
- 200001: local font not found
- 300001: same source task is loading
- 300002: download fail |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### LoadFontFaceOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| global | √ | x | 4.0 |\n| family | √ | x | 4.0 |\n| source | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise<[AsyncApiSuccessResult](#asyncapisuccessresult-values)> | 否 | \n\n#### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","compatibility":"### loadFontFace 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[loadFontFace](https://doc.dcloud.net.cn/uni-app-x/api/load-font-face.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.load-font-face)\n"},"load-font-face":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/load-font-face/load-font-face.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/load-font-face/load-font-face\n>Template\n```vue\n\r\n \r\n \r\n 全局加载字体:\r\n font-family: uni.ttf\r\n \r\n {{\r\n uniIcon1\r\n }}\r\n \\ue100\r\n {{\r\n uniIcon2\r\n }}\r\n \\ue101\r\n \r\n 非全局加载字体:\r\n font-family: 阿里妈妈刀隶体-ttf\r\n (网络字体下载后生效)\r\n font-family:\r\n 阿里妈妈刀隶体-otf\r\n font-family: 阿里妈妈刀隶体-woff\r\n font-family: 阿里妈妈刀隶体-woff2\r\n \r\n \r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n uniIcon1: '\\ue100',\r\n uniIcon2: '\\ue101',\r\n }\r\n },\r\n onLoad() {\r\n uni.loadFontFace({\r\n global: true,\r\n family: 'UniFontFamily',\r\n source: \"url('/static/font/uni.ttf')\",\r\n success() {\r\n console.log('global loadFontFace uni.ttf success')\r\n },\r\n fail(error) {\r\n console.warn('global loadFontFace uni.ttf fail', error.errMsg)\r\n },\r\n })\r\n uni.loadFontFace({\r\n family: 'AlimamaDaoLiTiTTF',\r\n source:\r\n \"url('https://qiniu-web-assets.dcloud.net.cn/uni-app-x/static/font/AlimamaDaoLiTi.ttf')\",\r\n success() {\r\n console.log('loadFontFace Remote AlimamaDaoLiTi.ttf success')\r\n },\r\n fail(error) {\r\n console.warn('loadFontFace Remote AlimamaDaoLiTi.ttf fail', error.errMsg)\r\n },\r\n })\r\n uni.loadFontFace({\r\n family: 'AlimamaDaoLiTiOTF',\r\n source: \"url('/static/font/AlimamaDaoLiTi.otf')\",\r\n success() {\r\n console.log('loadFontFace AlimamaDaoLiTi.otf success')\r\n },\r\n fail(error) {\r\n console.warn('loadFontFace AlimamaDaoLiTi.otf fail', error.errMsg)\r\n },\r\n })\r\n uni.loadFontFace({\r\n family: 'AlimamaDaoLiTiWOFF',\r\n source: \"url('/static/font/AlimamaDaoLiTi.woff')\",\r\n success() {\r\n console.log('loadFontFace AlimamaDaoLiTi.woff success')\r\n },\r\n fail(error) {\r\n console.warn('loadFontFace AlimamaDaoLiTi.woff fail', error.errMsg)\r\n },\r\n })\r\n uni.loadFontFace({\r\n family: 'AlimamaDaoLiTiWOFF2',\r\n source: \"url('/static/font/AlimamaDaoLiTi.woff2')\",\r\n success() {\r\n console.log('loadFontFace AlimamaDaoLiTi.woff2 success')\r\n },\r\n fail(error) {\r\n console.warn('loadFontFace AlimamaDaoLiTi.woff2 fail', error.errMsg)\r\n },\r\n })\r\n },\r\n methods: {\r\n navigateToChild() {\r\n uni.navigateTo({\r\n url: '/pages/API/load-font-face/load-font-face-child',\r\n })\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"request":{"name":"## uni.request(param) @request","description":"发起网络请求。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| param | [RequestOptions\\](#requestoptions-values) | 是 | - | 网络请求参数 |\n#### RequestOptions\\ 的属性值 @requestoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string | 是 | - | 开发者服务器接口地址 |\n| data | any | 否 | null | 请求的参数 UTSJSONObject\\|string类型 |\n| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 否 | null | 设置请求的 header,header 中不能设置 Referer |\n| method | \"GET\" \\\\| \"POST\" \\\\| \"PUT\" \\\\| \"PATCH\" \\\\| \"DELETE\" \\\\| \"HEAD\" \\\\| \"OPTIONS\" | 否 | \"GET\" | 请求方法
如果设置的值不在取值范围内,会以GET方法进行请求。 |\n| timeout | number | 否 | 60000 | 超时时间,单位 ms |\n| firstIpv4 | boolean | 否 | false | DNS解析时优先使用ipv4 |\n| success | (option: [RequestSuccess\\](#requestsuccess-values)) => void | 否 | null | 网络请求成功回调。 |\n| fail | (option: [RequestFail](#requestfail-values)) => void | 否 | null | 网络请求失败回调。 |\n| complete | (option: any) => void | 否 | null | 网络请求完成回调,成功或者失败都会调用。 |\n\n##### RequestSuccess\\ 的属性值 @requestsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | T | 否 | - | 开发者服务器返回的数据 |\n| statusCode | number | 是 | - | 开发者服务器返回的 HTTP 状态码 |\n| header | any | 是 | - | 开发者服务器返回的 HTTP Response Header |\n| cookies | Array\\ | 是 | - | 开发者服务器返回的 cookies,格式为字符串数组 |\n\n##### RequestFail 的属性值 @requestfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 5 \\\\| 1000 \\\\| 100001 \\\\| 100002 \\\\| 600003 \\\\| 600009 \\\\| 602001 | 是 | - | 错误码
- 5 接口超时
- 1000 服务端系统错误
- 100001 json数据解析错误
- 100002 错误信息json解析失败
- 600003 网络中断
- 600009 URL格式不合法
- 602001 request系统错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RequestTask](#requesttask-values) | \n\n#### RequestTask 的方法 @requesttask-values \n\n#### abort() @abort\n中断网络请求。\n\n\n##### abort 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n\n\n##### 参见\n[abort](https://uniapp.dcloud.net.cn/api/request/request.html#request)\n","compatibility":"### request 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[request](https://uniapp.dcloud.net.cn/api/request/request.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.request)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/request/request.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/request/request\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n 地址 : {{ host + url}}\r\n 请求方式 : {{method}}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 设置请求方式\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 请求返回错误码的接口(默认为GET)\r\n \r\n \r\n \r\n \r\n \r\n \r\n 请求不同header的接口(默认为GET)\r\n \r\n \r\n \r\n \r\n \r\n \r\n 请求不同content-type的接口(默认为GET)\r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n POST请求(有body)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n const duration = 2000\r\n const methodMap = {\r\n \"GET\": \"/api/http/method/get\",\r\n \"POST\": \"/api/http/method/post\",\r\n \"PUT\": \"/api/http/method/put\",\r\n \"DELETE\": \"/api/http/method/delete\",\r\n \"PATCH\": \"/api/http/method/patch\",\r\n \"OPTIONS\": \"/api/http/method/options\",\r\n \"HEAD\": \"/api/http/method/head\"\r\n }\r\n\r\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'request',\r\n res: '',\r\n task: null as RequestTask | null,\r\n host: \"https://request.dcloud.net.cn\",\r\n url: \"/api/http/method/get\",\r\n method: \"GET\" as RequestMethod | null,\r\n data: null as any | null,\r\n header: null as UTSJSONObject | null,\r\n errorCodeUrls: [\r\n \"/api/http/statusCode/200\",\r\n \"/api/http/statusCode/204\",\r\n \"/api/http/statusCode/301\",\r\n \"/api/http/statusCode/302\",\r\n \"/api/http/statusCode/307\",\r\n \"/api/http/statusCode/400\",\r\n \"/api/http/statusCode/401\",\r\n \"/api/http/statusCode/403\",\r\n \"/api/http/statusCode/404\",\r\n \"/api/http/statusCode/405\",\r\n \"/api/http/statusCode/500\",\r\n \"/api/http/statusCode/502\",\r\n \"/api/http/statusCode/503\",\r\n \"/api/http/statusCode/504\",\r\n ],\r\n headerUrls: [\r\n \"/api/http/header/ua\",\r\n \"/api/http/header/referer\",\r\n \"/api/http/header/requestCookie\",\r\n \"/api/http/header/setCookie\",\r\n \"/api/http/header/deleteCookie\"\r\n ],\r\n contentTypeUrls: [\r\n \"/api/http/contentType/text/plain\",\r\n \"/api/http/contentType/text/html\",\r\n \"/api/http/contentType/text/xml\",\r\n \"/api/http/contentType/image/gif\",\r\n \"/api/http/contentType/image/jpeg\",\r\n \"/api/http/contentType/image/png\",\r\n \"/api/http/contentType/application/json\",\r\n \"/api/http/contentType/application/octetStream\",\r\n ],\r\n postUrls: [\r\n \"/api/http/contentType/json\",\r\n \"/api/http/contentType/xWwwFormUrlencoded\",\r\n ],\r\n //自动化测试例专用\r\n jest_result: false\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n changeMethod(e : RequestMethod) {\r\n this.method = e;\r\n this.url = methodMap[e] as string;\r\n this.data = null;\r\n this.header = null;\r\n },\r\n changeUrl(e : string) {\r\n this.method = \"GET\";\r\n this.url = e;\r\n this.data = null;\r\n this.header = null;\r\n },\r\n changeUrlFromPost(e : string) {\r\n this.method = \"POST\";\r\n this.url = e;\r\n switch (e) {\r\n case \"/api/http/contentType/json\":\r\n this.header = {\r\n \"Content-Type\": \"application/json\"\r\n };\r\n this.data = {\r\n \"hello\": \"world\"\r\n };\r\n break;\r\n case \"/api/http/contentType/xWwwFormUrlencoded\":\r\n this.header = {\r\n \"Content-Type\": \"application/x-www-form-urlencoded\"\r\n };\r\n this.data = \"hello=world\";\r\n break;\r\n }\r\n },\r\n sendRequest() {\r\n uni.showLoading({\r\n title: \"请求中...\"\r\n })\r\n this.task = uni.request({\r\n url: this.host + this.url,\r\n // dataType: \"json\",\r\n // responseType: \"json\",\r\n method: this.method,\r\n data: this.data,\r\n header: this.header,\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: (res) => {\r\n console.log('request success', JSON.stringify(res.data))\r\n console.log('request success header is :', JSON.stringify(res.header))\r\n uni.showToast({\r\n title: '请求成功',\r\n icon: 'success',\r\n mask: true,\r\n duration: duration\r\n });\r\n this.res = '请求结果 : ' + JSON.stringify(res);\r\n },\r\n fail: (err) => {\r\n console.log('request fail', err);\r\n uni.showModal({\r\n content: err.errMsg,\r\n showCancel: false\r\n });\r\n },\r\n complete: () => {\r\n uni.hideLoading()\r\n },\r\n });\r\n },\r\n //自动化测试例专用\r\n jest_request() {\r\n uni.request({\r\n url: this.host + this.url,\r\n // dataType: \"json\",\r\n // responseType: \"json\",\r\n method: this.method,\r\n data: this.data,\r\n header: this.header,\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_set_cookie() {\r\n uni.request({\r\n url: this.host + \"/api/http/header/setCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_request(true)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_delete_cookie() {\r\n uni.request({\r\n url: this.host + \"/api/http/header/deleteCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_request(false)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_cookie_request(needCookie : boolean) {\r\n uni.request({\r\n url: this.host + \"/api/http/header/requestCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: (res) => {\r\n const requestCookie = (res.data as UTSJSONObject).getJSON(\"data\")?.getAny(\"requestCookie\")\r\n console.log(\"requestCookie \", requestCookie);\r\n if (requestCookie instanceof Array) {\r\n this.jest_result = needCookie ? requestCookie.length > 0 : requestCookie.length == 0\r\n } else {\r\n this.jest_result = needCookie ? (requestCookie as UTSJSONObject).toMap().size > 0 : (requestCookie as UTSJSONObject).toMap().size == 0\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n }\r\n }\r\n\n```\n\n:::"},"uploadFile":{"name":"## uni.uploadFile(options) @uploadfile","description":"将本地资源上传到开发者服务器。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UploadFileOptions](#uploadfileoptions-values) | 是 | - | - |\n#### UploadFileOptions 的属性值 @uploadfileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string | 是 | - | 开发者服务器 url |\n| filePath | string | 否 | null | 要上传文件资源的路径 |\n| name | string | 否 | null | 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容 |\n| files | Array\\<[UploadFileOptionFiles](#uploadfileoptionfiles-values)\\> | 否 | null | 需要上传的文件列表。 |\n| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 否 | null | HTTP 请求 Header, header 中不能设置 Referer |\n| formData | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 否 | null | HTTP 请求中其他额外的 form data |\n| timeout | number | 否 | 120000 | 超时时间,单位 ms |\n| success | (result: [UploadFileSuccess](#uploadfilesuccess-values)) => void | 否 | null | 成功返回的回调函数 |\n| fail | (result: [UploadFileFail](#uploadfilefail-values)) => void | 否 | null | 失败的回调函数 |\n| complete | (result: any) => void | 否 | null | 结束的回调函数(调用成功、失败都会执行) |\n\n##### UploadFileOptionFiles 的属性值 @uploadfileoptionfiles-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 否 | \"file\" | multipart 提交时,表单的项目名,默认为 file,如果 name 不填或填的值相同,可能导致服务端读取文件时只能读取到一个文件。 |\n| uri | string | 是 | - | 要上传文件资源的路径 |\n\n##### UploadFileSuccess 的属性值 @uploadfilesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | string | 是 | - | 开发者服务器返回的数据 |\n| statusCode | number | 是 | - | 开发者服务器返回的 HTTP 状态码 |\n\n##### UploadFileFail 的属性值 @uploadfilefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 5 \\\\| 1000 \\\\| 100001 \\\\| 100002 \\\\| 600003 \\\\| 600009 \\\\| 602001 | 是 | - | 错误码
- 5 接口超时
- 1000 服务端系统错误
- 100001 json数据解析错误
- 100002 错误信息json解析失败
- 600003 网络中断
- 600009 URL格式不合法
- 602001 request系统错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UploadTask](#uploadtask-values) | \n\n#### UploadTask 的方法 @uploadtask-values \n\n#### abort() @abort\n中断上传任务。\n\n\n##### abort 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[abort](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听上传进度变化。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnProgressUpdateResult](#onprogressupdateresult-values)) => void | 是 | - | - |\n###### OnProgressUpdateResult 的属性值 @onprogressupdateresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| progress | number | 是 | - | 上传进度百分比 |\n| totalBytesSent | number | 是 | - | 已经上传的数据长度,单位 Bytes |\n| totalBytesExpectedToSend | number | 是 | - | 预期需要上传的数据总长度,单位 Bytes |\n\n\n##### onProgressUpdate 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n\n\n##### 参见\n[onProgressUpdate](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n","compatibility":"### uploadFile 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[uploadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.upload-file)\n"},"upload-file":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/upload-file/upload-file.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/upload-file/upload-file\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n + 选择图片\r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'uploadFile',\r\n imageSrc: '',\r\n task: null as UploadTask | null,\r\n //自动化测试例专用\r\n jest_result: false,\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n this.imageSrc = '';\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n chooseImage: function () {\r\n uni.chooseImage({\r\n count: 1,\r\n sizeType: ['compressed'],\r\n sourceType: ['album'],\r\n success: (res) => {\r\n console.log('chooseImage success, temp path is', res.tempFilePaths[0])\r\n var imageSrc = res.tempFilePaths[0]\r\n uni.showLoading({\r\n title: '上传中'\r\n })\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload', //仅为示例,非真实的接口地址\r\n filePath: imageSrc,\r\n name: 'file',\r\n formData: {\r\n 'user': 'test'\r\n },\r\n success: (res) => {\r\n console.log('uploadImage success, res is:', res)\r\n uni.hideLoading();\r\n uni.showToast({\r\n title: '上传成功',\r\n icon: 'success',\r\n duration: 1000\r\n })\r\n this.imageSrc = imageSrc\r\n },\r\n fail: (err) => {\r\n console.log('uploadImage fail', err);\r\n uni.hideLoading();\r\n uni.showModal({\r\n content: err.errMsg,\r\n showCancel: false\r\n });\r\n },\r\n });\r\n },\r\n fail: (err) => {\r\n console.log('chooseImage fail', err)\r\n }\r\n })\r\n },\r\n //自动化测试例专用\r\n jest_uploadFile() {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload', //仅为示例,非真实的接口地址\r\n filePath: imageSrc,\r\n name: 'file',\r\n formData: {\r\n 'user': 'test'\r\n },\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\r\n jest_set_cookie() {\r\n uni.request({\r\n url: \"https://request.dcloud.net.cn/api/http/header/setCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_upload(true)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n\r\n jest_delete_cookie() {\r\n uni.request({\r\n url: \"https://request.dcloud.net.cn/api/http/header/deleteCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_upload(false)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_cookie_upload(needCookie : boolean) {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://request.dcloud.net.cn/api/http/header/upload',\r\n filePath: imageSrc,\r\n name: 'file',\r\n success: (res : UploadFileSuccess) => {\r\n const data = JSON.parseObject(res.data)\r\n const errCode = data?.getNumber(\"errCode\")\r\n if (errCode != null && errCode == 1000) {\r\n this.jest_result = needCookie ? false : true;\r\n } else {\r\n this.jest_result = needCookie ? true : false;\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\r\n jest_files_upload() {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload',\r\n files: [\r\n {\r\n name: \"file1\",\r\n uri: imageSrc\r\n } as UploadFileOptionFiles,\r\n {\r\n name: \"file2\",\r\n uri: imageSrc\r\n } as UploadFileOptionFiles\r\n ],\r\n success: (res : UploadFileSuccess) => {\r\n if (res.statusCode == 200) {\r\n this.jest_result = true;\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"downloadFile":{"name":"## uni.downloadFile(options) @downloadfile","description":"下载文件资源到本地,客户端直接发起一个 HTTP GET 请求,返回文件的本地临时路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [DownloadFileOptions](#downloadfileoptions-values) | 是 | - | - |\n#### DownloadFileOptions 的属性值 @downloadfileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string | 是 | - | 下载资源的 url |\n| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 否 | null | HTTP 请求 Header,header 中不能设置 Referer |\n| filePath | string | 否 | null | 指定文件下载路径 支持相对路径与绝对路径,例: `/imgs/pic.png`、`/storage/emulated/0/Android/data/io.dcloud.HBuilder/apps/HBuilder/temp/imgs/pic.png` 并且支持指定下载目录,例: `/imgs/` |\n| timeout | number | 否 | 120000 | 超时时间,单位 ms |\n| success | (result: [DownloadFileSuccess](#downloadfilesuccess-values)) => void | 否 | null | 下载成功后以 tempFilePath 的形式传给页面,res = {tempFilePath: '文件的临时路径'} |\n| fail | (result: [DownloadFileFail](#downloadfilefail-values)) => void | 否 | null | 失败的回调函数 |\n| complete | (result: any) => void | 否 | null | 结束的回调函数(调用成功、失败都会执行) |\n\n##### DownloadFileSuccess 的属性值 @downloadfilesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| tempFilePath | string | 是 | - | 临时文件路径,下载后的文件会存储到一个临时文件 |\n| statusCode | number | 是 | - | 开发者服务器返回的 HTTP 状态码 |\n\n##### DownloadFileFail 的属性值 @downloadfilefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 5 \\\\| 1000 \\\\| 100001 \\\\| 100002 \\\\| 600003 \\\\| 600009 \\\\| 602001 | 是 | - | 错误码
- 5 接口超时
- 1000 服务端系统错误
- 100001 json数据解析错误
- 100002 错误信息json解析失败
- 600003 网络中断
- 600009 URL格式不合法
- 602001 request系统错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [DownloadTask](#downloadtask-values) | \n\n#### DownloadTask 的方法 @downloadtask-values \n\n#### abort() @abort\n中断下载任务。\n\n\n##### abort 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n\n\n##### 参见\n[abort](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听下载进度变化。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnProgressDownloadResult](#onprogressdownloadresult-values)) => void | 是 | - | - |\n###### OnProgressDownloadResult 的属性值 @onprogressdownloadresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| progress | number | 是 | - | 下载进度百分比 |\n| totalBytesWritten | number | 是 | - | 已经下载的数据长度,单位 Bytes |\n| totalBytesExpectedToWrite | number | 是 | - | 预期需要下载的数据总长度,单位 Bytes |\n\n\n##### onProgressUpdate 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n\n\n##### 参见\n[onProgressUpdate](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n","compatibility":"### downloadFile 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[downloadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.download-file)\n"},"download-file":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/download-file/download-file.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/download-file/download-file\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 点击按钮下载服务端示例图片(下载网络文件到本地临时目录)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'downloadFile',\r\n imageSrc: '',\r\n task: null as DownloadTask | null,\r\n //自动化测试例专用\r\n jest_result: false\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n // this.imageSrc = '';\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n downloadImage: function () {\r\n uni.showLoading({\r\n title: '下载中'\r\n })\r\n var self = this\r\n this.task = uni.downloadFile({\r\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\r\n success: (res) => {\r\n console.log('downloadFile success, res is', res.tempFilePath)\r\n self.imageSrc = res.tempFilePath;\r\n uni.hideLoading();\r\n },\r\n fail: (err) => {\r\n console.log('downloadFile fail, err is:', err)\r\n uni.hideLoading();\r\n }\r\n });\r\n this.task?.onProgressUpdate((update) => {\r\n console.log(\"progress : \", update.progress);\r\n })\r\n },\r\n //自动化测试例专用\r\n jest_downloadFile() {\r\n uni.downloadFile({\r\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\r\n success: () => {\r\n this.jest_result = true\r\n },\r\n fail: () => {\r\n this.jest_result = false\r\n }\r\n });\r\n },\n\n jest_set_cookie(){\n uni.request({\n url: \"https://request.dcloud.net.cn/api/http/header/setCookie\",\n method: \"GET\",\n timeout: 6000,\n sslVerify: false,\n withCredentials: true,\n firstIpv4: false,\n success: () => {\n this.jest_cookie_download(true)\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n\n jest_delete_cookie(){\n uni.request({\n url: \"https://request.dcloud.net.cn/api/http/header/deleteCookie\",\n method: \"GET\",\n timeout: 6000,\n sslVerify: false,\n withCredentials: true,\n firstIpv4: false,\n success: () => {\n this.jest_cookie_download(false)\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n jest_cookie_download(needCookie: boolean){\n uni.downloadFile({\n url: \"https://request.dcloud.net.cn/api/http/header/download\",\n success: () => {\n this.jest_result = needCookie ? true : false;\n },\n fail: () => {\n this.jest_result = needCookie ? false : true;\n }\n });\n }\r\n }\r\n }\r\n\n```\n\n:::"},"getNetworkType":{"name":"## uni.getNetworkType(options) @getnetworktype","description":"获取网络类型","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetNetworkTypeOptions](#getnetworktypeoptions-values) | 是 | - | - |\n#### GetNetworkTypeOptions 的属性值 @getnetworktypeoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (result: [GetNetworkTypeSuccess](#getnetworktypesuccess-values)) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### GetNetworkTypeSuccess 的属性值 @getnetworktypesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| networkType | string | 是 | - | 网络类型 |\n","returnValue":"","compatibility":"### getNetworkType 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getNetworkType](http://uniapp.dcloud.io/api/system/network?id=getnetworktype)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.get-network-type)\n"},"get-network-type":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-network-type/get-network-type.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-network-type/get-network-type\n>Template\n```vue\n\r\n \r\n \r\n \r\n 网络状态\r\n \r\n 未获取\r\n 请点击下面按钮获取网络状态\r\n \r\n \r\n {{networkType}}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'getNetworkType',\r\n hasNetworkType: false,\r\n networkType: '',\r\n connectedWifi: '',\r\n //自动化测试例专用\r\n jest_result: false,\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload: function () {\r\n this.networkType = '';\r\n this.hasNetworkType = false;\r\n },\r\n methods: {\r\n getNetworkType: function () {\r\n uni.getNetworkType({\r\n success: (res) => {\r\n console.log(res)\r\n this.hasNetworkType = true;\r\n this.networkType = res.networkType\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n content: '获取失败!',\r\n showCancel: false\r\n })\r\n }\r\n })\r\n },\r\n clear: function () {\r\n this.hasNetworkType = false;\r\n this.networkType = '';\r\n this.connectedWifi = '';\r\n },\r\n //自动化测试例专用\r\n jest_getNetworkType() {\r\n uni.getNetworkType({\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"connectSocket":{"name":"## connectSocket(options) @connectsocket","description":"创建一个 WebSocket 连接。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ConnectSocketOptions](#connectsocketoptions-values) | 是 | - | - |\n#### ConnectSocketOptions 的属性值 @connectsocketoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string | 是 | - | 开发者服务器接口地址,必须是 wss 协议,且域名必须是后台配置的合法域名 |\n| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 否 | null | HTTP 请求 Header,header 中不能设置 Referer |\n| protocols | Array\\ | 否 | null | 子协议数组 |\n| success | (result: [ConnectSocketSuccess](#connectsocketsuccess-values)) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (result: [ConnectSocketFail](#connectsocketfail-values)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### ConnectSocketSuccess 的属性值 @connectsocketsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### ConnectSocketFail 的属性值 @connectsocketfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | 错误码 - 600009 URL格式不合法 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [SocketTask](#sockettask-values) | \n\n#### SocketTask 的方法 @sockettask-values \n\n#### send(options) @send\n通过 WebSocket 连接发送数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions-values) | 是 | - | - |\n###### SendSocketMessageOptions 的属性值 @sendsocketmessageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | any | 是 | - | 需要发送的内容 |\n| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (result: [SendSocketMessageFail](#sendsocketmessagefail-values)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n###### SendSocketMessageFail 的属性值 @sendsocketmessagefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 10001 \\\\| 10002 \\\\| 602001 | 是 | - | 错误码
- 10001 发送数据超限,发送队列不能超过16M大小。
- 10002 websocket未连接
- 602001 websocket系统错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n\n##### send 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[send](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-send)\n\n#### close(options) @close\n关闭 WebSocket 连接\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [CloseSocketOptions](#closesocketoptions-values) | 是 | - | - |\n###### CloseSocketOptions 的属性值 @closesocketoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| code | number | 否 | 1000 | 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭) |\n| reason | string | 否 | \"\" | 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本(不是字符) |\n| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n\n##### close 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[close](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-close)\n\n#### onOpen(callback) @onopen\n监听 WebSocket 连接打开事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketOpenCallbackResult](#onsocketopencallbackresult-values)) => void | 是 | - | - |\n###### OnSocketOpenCallbackResult 的属性值 @onsocketopencallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| header | any | 是 | - | 连接成功的 HTTP 响应 Header |\n\n\n##### onOpen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[onOpen](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onopen)\n\n#### onClose(callback) @onclose\n监听 WebSocket 连接关闭事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n\n##### onClose 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[onClose](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onclose)\n\n#### onError(callback) @onerror\n监听 WebSocket 错误\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 是 | - | - |\n\n##### onError 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[onError](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onerror)\n\n#### onMessage(callback) @onmessage\n监听 WebSocket 接受到服务器的消息事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketMessageCallbackResult](#onsocketmessagecallbackresult-values)) => void | 是 | - | - |\n###### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | any | 是 | - | 服务器返回的消息 |\n\n\n##### onMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[onMessage](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onmessage)\n","compatibility":"### connectSocket 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[connectSocket](https://uniapp.dcloud.net.cn/api/request/websocket.html#connectsocket)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.connectSocket)\n"},"onSocketOpen":{"name":"## onSocketOpen(options) @onsocketopen","description":"监听WebSocket连接打开事件。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | (result: [OnSocketOpenCallbackResult](#onsocketopencallbackresult-values)) => void | 是 | - | - |","returnValue":"","compatibility":"### onSocketOpen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[onSocketOpen](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketopen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketOpen)\n"},"onSocketError":{"name":"## onSocketError(callback) @onsocketerror","description":"下载文件资源到本地,客户端直接发起一个 HTTP GET 请求,返回文件的本地临时路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketErrorCallbackResult](#onsocketerrorcallbackresult-values)) => void | 是 | - | - |\n#### OnSocketErrorCallbackResult 的属性值 @onsocketerrorcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | 错误信息 |\n","returnValue":"","compatibility":"### onSocketError 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[onSocketError](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketerror)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketError)\n"},"sendSocketMessage":{"name":"## sendSocketMessage(options) @sendsocketmessage","description":"通过 WebSocket 连接发送数据,需要先 uni.connectSocket,并在 uni.onSocketOpen 回调之后才能发送。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions-values) | 是 | - | - |\n#### SendSocketMessageOptions 的属性值 @sendsocketmessageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | any | 是 | - | 需要发送的内容 |\n| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (result: [SendSocketMessageFail](#sendsocketmessagefail-values)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SendSocketMessageFail 的属性值 @sendsocketmessagefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 10001 \\\\| 10002 \\\\| 602001 | 是 | - | 错误码
- 10001 发送数据超限,发送队列不能超过16M大小。
- 10002 websocket未连接
- 602001 websocket系统错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"","compatibility":"### sendSocketMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[sendSocketMessage](https://uniapp.dcloud.net.cn/api/request/websocket.html#sendsocketmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.sendSocketMessage)\n"},"onSocketMessage":{"name":"## onSocketMessage(callback) @onsocketmessage","description":"监听WebSocket接受到服务器的消息事件。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketMessageCallbackResult](#onsocketmessagecallbackresult-values)) => void | 是 | - | - |\n#### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | any | 是 | - | 服务器返回的消息 |\n","returnValue":"","compatibility":"### onSocketMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[onSocketMessage](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketMessage)\n"},"closeSocket":{"name":"## closeSocket(options) @closesocket","description":"关闭 WebSocket 连接。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [CloseSocketOptions](#closesocketoptions-values) | 是 | - | - |\n#### CloseSocketOptions 的属性值 @closesocketoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| code | number | 否 | 1000 | 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭) |\n| reason | string | 否 | \"\" | 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本(不是字符) |\n| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n","returnValue":"","compatibility":"### closeSocket 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[closeSocket](https://uniapp.dcloud.net.cn/api/request/websocket.html#closesocket)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.closeSocket)\n"},"onSocketClose":{"name":"## onSocketClose(callback) @onsocketclose","description":"监听WebSocket关闭。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketCloseCallbackResult](#onsocketclosecallbackresult-values)) => void | 是 | - | - |\n#### OnSocketCloseCallbackResult 的属性值 @onsocketclosecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| code | number | 是 | - | 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。\t |\n| reason | string | 是 | - | 一个可读的字符串,表示连接被关闭的原因。\t |\n","returnValue":"","compatibility":"### onSocketClose 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[onSocketClose](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketclose)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketClose)\n"},"websocket-global":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/websocket-global/websocket-global.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/websocket-global/websocket-global\n>Template\n```vue\n\r\n \r\n \r\n \r\n {{ showMsg }}\r\n \r\n \r\n \r\n 发送消息后会收到一条服务器返回的消息(与发送的消息内容一致)\r\n \r\n \r\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n connected: false,\r\n connecting: false,\r\n msg: '',\r\n roomId: '',\r\n platform: '',\r\n }\r\n },\r\n computed: {\r\n showMsg() : string {\r\n if (this.connected) {\r\n if (this.msg.length > 0) {\r\n return '收到消息:' + this.msg\r\n } else {\r\n return '等待接收消息'\r\n }\r\n } else {\r\n return '尚未连接'\r\n }\r\n },\r\n },\r\n onLoad() {\r\n this.platform = uni.getSystemInfoSync().platform\r\n },\r\n onUnload() {\r\n uni.closeSocket({\r\n code: 1000,\r\n reason: 'close reason from client',\r\n success: (res : any) => {\r\n console.log('uni.closeSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n console.log('uni.closeSocket fail', err)\r\n },\r\n } as CloseSocketOptions)\r\n uni.hideLoading()\r\n },\r\n methods: {\r\n connect() {\r\n if (this.connected || this.connecting) {\r\n uni.showModal({\r\n content: '正在连接或者已经连接,请勿重复连接',\r\n showCancel: false,\r\n })\r\n return\r\n }\r\n this.connecting = true\r\n uni.showLoading({\r\n title: '连接中...',\r\n })\r\n uni.connectSocket({\r\n url: 'ws://websocket.dcloud.net.cn',\r\n header: null,\r\n protocols: null,\r\n success: (res : any) => {\r\n // 这里是接口调用成功的回调,不是连接成功的回调,请注意\r\n console.log('uni.connectSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n // 这里是接口调用失败的回调,不是连接失败的回调,请注意\r\n console.log('uni.connectSocket fail', err)\r\n },\r\n })\r\n uni.onSocketOpen((res) => {\r\n this.connecting = false\r\n this.connected = true\r\n uni.hideLoading()\r\n\r\n uni.showToast({\r\n icon: 'none',\r\n title: '连接成功',\r\n })\r\n console.log('onOpen', res)\r\n })\r\n uni.onSocketError((err) => {\r\n this.connecting = false\r\n this.connected = false\r\n uni.hideLoading()\r\n\r\n uni.showModal({\r\n content: '连接失败,可能是websocket服务不可用,请稍后再试',\r\n showCancel: false,\r\n })\r\n console.log('onError', err)\r\n })\r\n uni.onSocketMessage((res) => {\r\n this.msg = res.data as string\r\n console.log('onMessage', res)\r\n })\r\n uni.onSocketClose((res) => {\r\n this.connected = false\r\n this.msg = ''\r\n console.log('onClose', res)\r\n })\r\n },\r\n send() {\r\n uni.sendSocketMessage({\r\n data:\r\n 'from ' +\r\n this.platform +\r\n ' : ' +\r\n parseInt((Math.random() * 10000).toString()).toString(),\r\n success: (res : any) => {\r\n console.log(res)\r\n },\r\n fail: (err : any) => {\r\n console.log(err)\r\n },\r\n } as SendSocketMessageOptions)\r\n },\r\n close() {\r\n uni.closeSocket({\r\n code: 1000,\r\n reason: 'close reason from client',\r\n success: (res : any) => {\r\n console.log('uni.closeSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n console.log('uni.closeSocket fail', err)\r\n },\r\n } as CloseSocketOptions)\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"getSystemInfo":{"name":"## uni.getSystemInfo(options) @getsysteminfo","description":"异步获取系统信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetSystemInfoOptions](#getsysteminfooptions-values) | 是 | - | - |\n#### GetSystemInfoOptions 的属性值 @getsysteminfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (result: [GetSystemInfoResult](#getsysteminforesult-values)) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### GetSystemInfoResult 的属性值 @getsysteminforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SDKVersion | string | 是 | - | 客户端基础库版本 |\n| appId | string | 是 | - | `manifest.json` 中应用appid。 |\n| appLanguage | string | 是 | - | 应用设置的语言。 |\n| appName | string | 是 | - | `manifest.json` 中应用名称。 |\n| appVersion | string | 是 | - | `manifest.json` 中应用版本名称。 |\n| appVersionCode | string | 是 | - | `manifest.json` 中应用版本名号。 |\n| brand | string | 是 | - | 手机品牌。 |\n| browserName | string | 是 | - | 浏览器名称。`App` 端是系统 webview 的名字,比如 wkwebview、chrome。小程序端为空 |\n| browserVersion | string | 是 | - | 浏览器版本、webview 版本。 |\n| deviceId | string | 是 | - | 设备 ID |\n| deviceBrand | string | 是 | - | 设备品牌。如:`apple`、`huawei`。 |\n| deviceModel | string | 是 | - | 设备型号 |\n| deviceType | \"phone\" \\\\| \"pad\" \\\\| \"tv\" \\\\| \"watch\" \\\\| \"pc\" \\\\| \"undefined\" \\\\| \"car\" \\\\| \"vr\" \\\\| \"appliance\" | 是 | - | 设备类型。 |\n| devicePixelRatio | number | 是 | - | 设备像素比 |\n| deviceOrientation | \"portrait\" \\\\| \"landscape\" | 是 | - | 设备方向。 |\n| language | string | 是 | - | 程序设置的语言 |\n| model | string | 是 | - | 手机型号 |\n| osName | \"ios\" \\\\| \"android\" \\\\| \"mac\" \\\\| \"windows\" \\\\| \"linux\" | 是 | - | 系统名称\t |\n| osVersion | string | 是 | - | 操作系统版本。如 ios 版本,andriod 版本 |\n| osLanguage | string | 是 | - | 操作系统语言 |\n| osTheme | \"light\" \\\\| \"dark\" | 否 | - | 操作系统主题
|\n| pixelRatio | number | 是 | - | 设备像素比 |\n| platform | \"ios\" \\\\| \"android\" \\\\| \"mac\" \\\\| \"windows\" \\\\| \"linux\" | 是 | - | 客户端平台 |\n| screenWidth | number | 是 | - | 屏幕宽度 |\n| screenHeight | number | 是 | - | 屏幕高度 |\n| statusBarHeight | number | 是 | - | 状态栏的高度 |\n| system | string | 是 | - | 操作系统版本 |\n| safeArea | [SafeArea](#safearea-values) | 是 | - | 在竖屏正方向下的安全区域 |\n| safeAreaInsets | [SafeAreaInsets](#safeareainsets-values) | 是 | - | 在竖屏正方向下的安全区域插入位置 |\n| ua | string | 是 | - | 用户标识。小程序端为空 |\n| ~~uniCompileVersion~~ | string | 是 | - | uni 编译器版本 |\n| uniCompilerVersion | string | 是 | - | uni 编译器版本 |\n| uniPlatform | \"app\" \\\\| \"web\" \\\\| \"mp-weixin\" \\\\| \"mp-alipay\" \\\\| \"mp-baidu\" \\\\| \"mp-toutiao\" \\\\| \"mp-lark\" \\\\| \"mp-qq\" \\\\| \"mp-kuaishou\" \\\\| \"mp-jd\" \\\\| \"mp-360\" \\\\| \"quickapp-webview\" \\\\| \"quickapp-webview-union\" \\\\| \"quickapp-webview-huawei\" | 是 | - | uni-app 运行平台。 |\n| uniRuntimeVersion | string | 是 | - | uni 运行时版本 |\n| ~~uniCompileVersionCode~~ | number | 是 | - | uni 编译器版本号 |\n| uniCompilerVersionCode | number | 是 | - | uni 编译器版本号 |\n| uniRuntimeVersionCode | number | 是 | - | uni 运行时版本号 |\n| ~~version~~ | string | 是 | - | 引擎版本号。已废弃,仅为了向下兼容保留 |\n| romName | string | 是 | - | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios` |\n| romVersion | string | 是 | - | rom 版本号。Android 部分机型获取不到值。iOS 恒为 `ios 版本号` |\n| windowWidth | number | 是 | - | 可使用窗口宽度 |\n| windowHeight | number | 是 | - | 可使用窗口高度 |\n| windowTop | number | 是 | - | 可使用窗口的顶部位置 |\n| windowBottom | number | 是 | - | 可使用窗口的底部位置 |\n| osAndroidAPILevel | number | 否 | - | Android 系统API库的版本。 |\n\n###### SafeArea 的属性值 @safearea-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左上角横坐标 |\n| right | number | 是 | - | 安全区域右下角横坐标 |\n| top | number | 是 | - | 安全区域左上角纵坐标 |\n| bottom | number | 是 | - | 安全区域右下角纵坐标 |\n| width | number | 是 | - | 安全区域的宽度,单位逻辑像素 |\n| height | number | 是 | - | 安全区域的高度,单位逻辑像素 |\n\n###### SafeAreaInsets 的属性值 @safeareainsets-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左侧插入位置 |\n| right | number | 是 | - | 安全区域右侧插入位置 |\n| top | number | 是 | - | 安全区顶部插入位置 |\n| bottom | number | 是 | - | 安全区域底部插入位置 |\n\n###### GetSystemInfoResult 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| osTheme | √ | x | - |\n| osAndroidAPILevel | √ | x | - |\n","returnValue":"","compatibility":"### getSystemInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getSystemInfo](http://uniapp.dcloud.io/api/system/info?id=getsysteminfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-info.getSystemInfo)\n"},"getSystemInfoSync":{"name":"## uni.getSystemInfoSync() @getsysteminfosync","description":"同步获取系统信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetSystemInfoResult](#getsysteminforesult-values) | \n\n#### GetSystemInfoResult 的属性值 @getsysteminforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SDKVersion | string | 是 | - | 客户端基础库版本 |\n| appId | string | 是 | - | `manifest.json` 中应用appid。 |\n| appLanguage | string | 是 | - | 应用设置的语言。 |\n| appName | string | 是 | - | `manifest.json` 中应用名称。 |\n| appVersion | string | 是 | - | `manifest.json` 中应用版本名称。 |\n| appVersionCode | string | 是 | - | `manifest.json` 中应用版本名号。 |\n| brand | string | 是 | - | 手机品牌。 |\n| browserName | string | 是 | - | 浏览器名称。`App` 端是系统 webview 的名字,比如 wkwebview、chrome。小程序端为空 |\n| browserVersion | string | 是 | - | 浏览器版本、webview 版本。 |\n| deviceId | string | 是 | - | 设备 ID |\n| deviceBrand | string | 是 | - | 设备品牌。如:`apple`、`huawei`。 |\n| deviceModel | string | 是 | - | 设备型号 |\n| deviceType | \"phone\" \\\\| \"pad\" \\\\| \"tv\" \\\\| \"watch\" \\\\| \"pc\" \\\\| \"null\" \\\\| \"car\" \\\\| \"vr\" \\\\| \"appliance\" | 是 | - | 设备类型。 |\n| devicePixelRatio | number | 是 | - | 设备像素比 |\n| deviceOrientation | \"portrait\" \\\\| \"landscape\" | 是 | - | 设备方向。 |\n| language | string | 是 | - | 程序设置的语言 |\n| model | string | 是 | - | 手机型号 |\n| osName | \"ios\" \\\\| \"android\" \\\\| \"mac\" \\\\| \"windows\" \\\\| \"linux\" | 是 | - | 系统名称\t |\n| osVersion | string | 是 | - | 操作系统版本。如 ios 版本,andriod 版本 |\n| osLanguage | string | 是 | - | 操作系统语言 |\n| osTheme | \"light\" \\\\| \"dark\" | 否 | - | 操作系统主题
|\n| pixelRatio | number | 是 | - | 设备像素比 |\n| platform | \"ios\" \\\\| \"android\" \\\\| \"mac\" \\\\| \"windows\" \\\\| \"linux\" | 是 | - | 客户端平台 |\n| screenWidth | number | 是 | - | 屏幕宽度 |\n| screenHeight | number | 是 | - | 屏幕高度 |\n| statusBarHeight | number | 是 | - | 状态栏的高度 |\n| system | string | 是 | - | 操作系统版本 |\n| safeArea | [SafeArea](#safearea-values) | 是 | - | 在竖屏正方向下的安全区域 |\n| safeAreaInsets | [SafeAreaInsets](#safeareainsets-values) | 是 | - | 在竖屏正方向下的安全区域插入位置 |\n| ua | string | 是 | - | 用户标识。小程序端为空 |\n| ~~uniCompileVersion~~ | string | 是 | - | uni 编译器版本 |\n| uniCompilerVersion | string | 是 | - | uni 编译器版本 |\n| uniPlatform | \"app\" \\\\| \"web\" \\\\| \"mp-weixin\" \\\\| \"mp-alipay\" \\\\| \"mp-baidu\" \\\\| \"mp-toutiao\" \\\\| \"mp-lark\" \\\\| \"mp-qq\" \\\\| \"mp-kuaishou\" \\\\| \"mp-jd\" \\\\| \"mp-360\" \\\\| \"quickapp-webview\" \\\\| \"quickapp-webview-union\" \\\\| \"quickapp-webview-huawei\" | 是 | - | uni-app 运行平台。 |\n| uniRuntimeVersion | string | 是 | - | uni 运行时版本 |\n| ~~uniCompileVersionCode~~ | number | 是 | - | uni 编译器版本号 |\n| uniCompilerVersionCode | number | 是 | - | uni 编译器版本号 |\n| uniRuntimeVersionCode | number | 是 | - | uni 运行时版本号 |\n| ~~version~~ | string | 是 | - | 引擎版本号。已废弃,仅为了向下兼容保留 |\n| romName | string | 是 | - | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios` |\n| romVersion | string | 是 | - | rom 版本号。Android 部分机型获取不到值。iOS 恒为 `ios 版本号` |\n| windowWidth | number | 是 | - | 可使用窗口宽度 |\n| windowHeight | number | 是 | - | 可使用窗口高度 |\n| windowTop | number | 是 | - | 可使用窗口的顶部位置 |\n| windowBottom | number | 是 | - | 可使用窗口的底部位置 |\n| osAndroidAPILevel | number | 否 | - | Android 系统API库的版本。 |\n\n##### SafeArea 的属性值 @safearea-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左上角横坐标 |\n| right | number | 是 | - | 安全区域右下角横坐标 |\n| top | number | 是 | - | 安全区域左上角纵坐标 |\n| bottom | number | 是 | - | 安全区域右下角纵坐标 |\n| width | number | 是 | - | 安全区域的宽度,单位逻辑像素 |\n| height | number | 是 | - | 安全区域的高度,单位逻辑像素 |\n\n##### SafeAreaInsets 的属性值 @safeareainsets-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左侧插入位置 |\n| right | number | 是 | - | 安全区域右侧插入位置 |\n| top | number | 是 | - | 安全区顶部插入位置 |\n| bottom | number | 是 | - | 安全区域底部插入位置 |\n\n##### GetSystemInfoResult 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| osTheme | √ | x | - |\n| osAndroidAPILevel | √ | x | - |\n","compatibility":"### getSystemInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getSystemInfoSync](http://uniapp.dcloud.io/api/system/info?id=getsysteminfosync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-info.getSystemInfoSync)\n"},"get-system-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-system-info/get-system-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-system-info/get-system-info\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{\r\n item.label\r\n }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getSystemInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n methods: {\r\n getSystemInfo: function () {\r\n uni.getSystemInfo({\r\n success: (res) => {\r\n this.items = [] as Item[];\r\n for (const key in res) {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n }\r\n },\r\n })\r\n },\r\n getSystemInfoSync: function () {\r\n this.items = [] as Item[];\r\n const res = uni.getSystemInfoSync()\r\n for (const key in res) {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n }\r\n },\r\n //自动化测试例专用\r\n jest_getSystemInfo() : GetSystemInfoResult {\r\n return uni.getSystemInfoSync();\r\n },\r\n }\r\n }\r\n\n```\n\n:::"},"getDeviceInfo":{"name":"## uni.getDeviceInfo(options?) @getdeviceinfo","description":"获取设备信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetDeviceInfoOptions](#getdeviceinfooptions-values) | 否 | 包含所有字段的过滤对象 | [options=包含所有字段的过滤对象\\] 过滤的字段对象, 不传参数默认为获取全部字段。 |\n#### GetDeviceInfoOptions 的属性值 @getdeviceinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filter | Array\\ | 是 | - | 过滤字段的字符串数组,假如要获取指定字段,传入此数组。 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetDeviceInfoResult](#getdeviceinforesult-values) | \n\n#### GetDeviceInfoResult 的属性值 @getdeviceinforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| brand | string | 否 | - | 设备品牌 |\n| deviceBrand | string | 否 | - | 设备品牌 |\n| deviceId | string | 否 | - | 设备 id 。由 uni-app 框架生成并存储,清空 Storage 会导致改变 |\n| model | string | 否 | - | 设备型号\t |\n| deviceModel | string | 否 | - | 设备型号\t |\n| deviceType | string | 否 | - | 设备类型phone、pad、pc\t |\n| deviceOrientation | string | 否 | - | 设备方向 竖屏 portrait、横屏 landscape\t |\n| devicePixelRatio | string | 否 | - | 设备像素比\t |\n| system | string | 否 | - | 操作系统及版本\t |\n| platform | string | 否 | - | 客户端平台\t |\n| isRoot | boolean | 否 | - | 是否root |\n| isSimulator | boolean | 否 | - | 是否是模拟器 |\n| isUSBDebugging | boolean | 否 | - | adb是否开启 |\n\n##### GetDeviceInfoResult 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| isUSBDebugging | √ | x | - |\n","compatibility":"### getDeviceInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getDeviceInfo](https://uniapp.dcloud.net.cn/api/system/getDeviceInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-device-info)\n"},"get-device-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-device-info/get-device-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-device-info/get-device-info\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{\r\n item.label\r\n }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { setDevicePixelRatio } from '@/store/index.uts'\r\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getDeviceInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n methods: {\r\n getDeviceInfo: function () {\r\n const res = uni.getDeviceInfo();\r\n // 获取像素比, 供截图对比使用\r\n setDevicePixelRatio(res.devicePixelRatio !== null ? parseFloat(res.devicePixelRatio!) : 1)\r\n this.items = [] as Item[];\r\n for (const key in res) {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n }\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"getWindowInfo":{"name":"## uni.getWindowInfo() @getwindowinfo","description":"同步获取窗口信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetWindowInfoResult](#getwindowinforesult-values) | \n\n#### GetWindowInfoResult 的属性值 @getwindowinforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| pixelRatio | number | 是 | - | 设备像素比 |\n| screenWidth | number | 是 | - | 屏幕宽度 |\n| screenHeight | number | 是 | - | 屏幕高度 |\n| windowWidth | number | 是 | - | 可使用窗口宽度 |\n| windowHeight | number | 是 | - | 可使用窗口高度 |\n| statusBarHeight | number | 是 | - | 状态栏的高度 |\n| windowTop | number | 是 | - | 可使用窗口的顶部位置 |\n| windowBottom | number | 是 | - | 可使用窗口的底部位置 |\n| safeArea | [SafeArea](#safearea-values) | 是 | - | 在竖屏正方向下的安全区域 |\n| safeAreaInsets | [SafeAreaInsets](#safeareainsets-values) | 是 | - | 在竖屏正方向下的安全区域插入位置 |\n| screenTop | number | 是 | - | 窗口上边缘的 y 值 |\n\n##### SafeArea 的属性值 @safearea-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左上角横坐标 |\n| right | number | 是 | - | 安全区域右下角横坐标 |\n| top | number | 是 | - | 安全区域左上角纵坐标 |\n| bottom | number | 是 | - | 安全区域右下角纵坐标 |\n| width | number | 是 | - | 安全区域的宽度,单位逻辑像素 |\n| height | number | 是 | - | 安全区域的高度,单位逻辑像素 |\n\n##### SafeAreaInsets 的属性值 @safeareainsets-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左侧插入位置 |\n| right | number | 是 | - | 安全区域右侧插入位置 |\n| top | number | 是 | - | 安全区顶部插入位置 |\n| bottom | number | 是 | - | 安全区域底部插入位置 |\n","compatibility":"### getWindowInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getWindowInfo](http://uniapp.dcloud.io/api/system/getWindowInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-window-info)\n"},"get-window-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-window-info/get-window-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-window-info/get-window-info\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n {{ item.label }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { setStatusBarHeight } from '@/store/index.uts'\r\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getWindowInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\n onReady() {\n this.getWindowInfo()\n },\r\n methods: {\r\n getWindowInfo: function () {\r\n const res = uni.getWindowInfo();\r\n // 获取状态栏+导航栏高度, 供截图对比使用\r\n setStatusBarHeight(res.statusBarHeight);\r\n this.items = [] as Item[];\r\n for (const key in res) {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n }\r\n },\r\n //自动化测试例专用\r\n jest_getWindowInfo() : GetWindowInfoResult {\r\n return uni.getWindowInfo();\r\n },\r\n }\r\n }\r\n\n```\n\n:::"},"getAppBaseInfo":{"name":"## uni.getAppBaseInfo(options?) @getappbaseinfo","description":"获取app基本信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetAppBaseInfoOptions](#getappbaseinfooptions-values) | 否 | 包含所有字段的过滤对象 | [options=包含所有字段的过滤对象\\] 过滤的字段对象, 不传参数默认为获取全部字段。 |\n#### GetAppBaseInfoOptions 的属性值 @getappbaseinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filter | Array\\ | 是 | - | 过滤字段的字符串数组,假如要获取指定字段,传入此数组。 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetAppBaseInfoResult](#getappbaseinforesult-values) | \n\n#### GetAppBaseInfoResult 的属性值 @getappbaseinforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| appId | string | 否 | - | manifest.json 中应用appid,即DCloud appid。\t |\n| appName | string | 否 | - | `manifest.json` 中应用名称。 |\n| appVersion | string | 否 | - | `manifest.json` 中应用版本名称。 |\n| appVersionCode | string | 否 | - | `manifest.json` 中应用版本名号。 |\n| appLanguage | string | 否 | - | 应用设置的语言en、zh-Hans、zh-Hant、fr、es\t |\n| language | string | 否 | - | 应用设置的语言\t |\n| ~~version~~ | string | 否 | - | 引擎版本号。已废弃,仅为了向下兼容保留 |\n| isUniAppX | boolean | 否 | - | 是否uni-app x |\n| ~~uniCompileVersion~~ | string | 否 | - | uni 编译器版本 |\n| uniCompilerVersion | string | 否 | - | uni 编译器版本 |\n| uniPlatform | \"app\" \\\\| \"web\" \\\\| \"mp-weixin\" \\\\| \"mp-alipay\" \\\\| \"mp-baidu\" \\\\| \"mp-toutiao\" \\\\| \"mp-lark\" \\\\| \"mp-qq\" \\\\| \"mp-kuaishou\" \\\\| \"mp-jd\" \\\\| \"mp-360\" \\\\| \"quickapp-webview\" \\\\| \"quickapp-webview-union\" \\\\| \"quickapp-webview-huawei\" | 否 | - | uni-app 运行平台。 |\n| uniRuntimeVersion | string | 否 | - | uni 运行时版本 |\n| ~~uniCompileVersionCode~~ | number | 否 | - | uni 编译器版本号 |\n| uniCompilerVersionCode | number | 否 | - | uni 编译器版本号 |\n| uniRuntimeVersionCode | number | 否 | - | uni 运行时版本号 |\n| packageName | string | 否 | - | Android的包名 |\n| signature | string | 否 | - | Android: 应用签名证书的SHA1值(全部为小写,中间不包含“:”)。 为了保证应用的安全性,请使用自己生成的证书(不要使用公共测试证书)。 iOS: 应用签名证书中绑定的Bundle ID(AppleID)的md5值(全部为小写)。 |\n\n##### GetAppBaseInfoResult 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| uniCompilerVersion | 4.0 | x | - |\n| uniCompilerVersionCode | 4.0 | x | - |\n| packageName | 3.97 | x | - |\n| signature | 3.97 | x | - |\n","compatibility":"### getAppBaseInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getAppBaseInfo](https://uniapp.dcloud.net.cn/api/system/getAppBaseInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-app-base-info)\n"},"get-app-base-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app-base-info/get-app-base-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-app-base-info/get-app-base-info\n>Template\n```vue\n\r\n \r\n \r\n \n \n \n {{item.label}}\n \n \n \n \n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\n\ttype Item = {\n\t\tlabel : string,\n\t\tvalue : string,\n\t}\n\texport default {\r\n\t\tdata() {\r\n\t\t\treturn {\r\n\t\t\t\ttitle: 'getAppBaseInfo',\n\t\t\t\titems: [] as Item[],\r\n\t\t\t}\r\n\t\t},\r\n\t\tonUnload:function(){\r\n\t\t},\r\n\t\tmethods: {\r\n\t\t\tgetAppBaseInfo: function () {\n\t\t\t\tconst res = uni.getAppBaseInfo();\n this.items = [] as Item[];\n for(const key in res){\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n }\n\t\t\t}\r\n\t\t}\r\n\t}\r\n\n```\n\n:::"},"getAppAuthorizeSetting":{"name":"## uni.getAppAuthorizeSetting() @getappauthorizesetting","description":"获取 APP 授权设置。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetAppAuthorizeSettingResult](#getappauthorizesettingresult-values) | \n\n#### GetAppAuthorizeSettingResult 的属性值 @getappauthorizesettingresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| cameraAuthorized | \"authorized\" \\\\| \"denied\" \\\\| \"not determined\" \\\\| \"config error\" | 是 | - | 允许 App 使用摄像头的开关
- authorized: 已经获得授权,无需再次请求授权
- denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
- not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
- config error: Android平台:表示没有授予 `android.permission.CAMERA` 权限;iOS平台没有该值 |\n| locationAuthorized | \"authorized\" \\\\| \"denied\" \\\\| \"not determined\" \\\\| \"config error\" | 是 | - | 允许 App 使用定位的开关
- authorized: 已经获得授权,无需再次请求授权
- denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
- not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
- config error: Android平台:表示没有授予 `android.permission.ACCESS_COARSE_LOCATION` 权限;iOS平台:表示没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块 |\n| locationAccuracy | \"reduced\" \\\\| \"full\" \\\\| \"unsupported\" | 否 | - | 定位准确度。
- reduced: 模糊定位
- full: 精准定位
- unsupported: 不支持(包括用户拒绝定位权限和没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块) |\n| microphoneAuthorized | \"authorized\" \\\\| \"denied\" \\\\| \"not determined\" \\\\| \"config error\" | 是 | - | 允许 App 使用麦克风的开关
- authorized: 已经获得授权,无需再次请求授权
- denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
- not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
- config error: Android平台:表示没有授予 `android.permission.RECORD_AUDIO` 权限;iOS平台没有该值 |\n| notificationAuthorized | \"authorized\" \\\\| \"denied\" \\\\| \"not determined\" \\\\| \"config error\" | 是 | - | 允许 App 通知的开关
- authorized: 已经获得授权,无需再次请求授权
- denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
- not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
- config error: Android平台没有该值;iOS平台:表示没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 |\n","compatibility":"### getAppAuthorizeSetting 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","tutorial":"\n### 参见\n[getAppAuthorizeSetting](http://uniapp.dcloud.io/api/system/getappauthorizesetting)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-app-authorize-setting)\n"},"get-app-authorize-setting":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app-authorize-setting/get-app-authorize-setting.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n 是否授权使用摄像头\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 是否授权使用定位\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 定位准确度\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 是否授权使用麦克风\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 是否授权通知\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```"},"getSystemSetting":{"name":"## uni.getSystemSetting() @getsystemsetting","description":"获取系统设置","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetSystemSettingResult](#getsystemsettingresult-values) | \n\n#### GetSystemSettingResult 的属性值 @getsystemsettingresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| bluetoothEnabled | boolean | 否 | - | 蓝牙是否开启 |\n| bluetoothError | string | 否 | - | 蓝牙的报错信息 |\n| locationEnabled | boolean | 是 | - | 位置是否开启 |\n| wifiEnabled | boolean | 否 | - | wifi是否开启 |\n| wifiError | string | 否 | - | wifi的报错信息 |\n| deviceOrientation | \"portrait\" \\\\| \"landscape\" | 是 | - | 设备方向 |\n","compatibility":"### getSystemSetting 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","tutorial":"\n### 参见\n[getSystemSetting](https://uniapp.dcloud.net.cn/api/system/getsystemsetting.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-setting)\n"},"get-system-setting":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-system-setting/get-system-setting.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n 蓝牙的系统开关\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 地理位置的系统开关\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n Wi-Fi 的系统开关\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 设备方向\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\n\r\n\r\n\r\n\n\n```"},"installApk":{"name":"## uni.installApk(options) @installapk","description":"安装apk","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [InstallApkOptions](#installapkoptions-values) | 是 | - | - |\n#### InstallApkOptions 的属性值 @installapkoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string | 是 | - | apk文件地址 |\n| success | (res: [InstallApkSuccess](#installapksuccess-values)) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (err: [InstallApkFail](#installapkfail-values)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### InstallApkSuccess 的属性值 @installapksuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | 安装成功消息 |\n\n##### InstallApkFail 的属性值 @installapkfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | 错误码 - 1300002 找不到文件 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"","compatibility":"### installApk 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.94 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.install-apk)\n"},"install-apk":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/install-apk/install-apk.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\n\n```"},"getPushClientId":{"name":"## uni.getPushClientId(options) @getpushclientid","description":"获取客户端唯一的推送标识","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetPushClientIdOptions](#getpushclientidoptions-values) | 是 | - | - |\n#### GetPushClientIdOptions 的属性值 @getpushclientidoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (result: [GetPushClientIdSuccess](#getpushclientidsuccess-values)) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### GetPushClientIdSuccess 的属性值 @getpushclientidsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| cid | string | 是 | - | 个推客户端推送id,对应uni-id-device表的push_clientid |\n| errMsg | string | 是 | - | 错误描述 |\n","returnValue":"","compatibility":"### getPushClientId 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[getPushClientId](http://uniapp.dcloud.io/api/plugins/push.html#getpushclientid)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.getPushClientId)\n"},"onPushMessage":{"name":"## uni.onPushMessage(callback) @onpushmessage","description":"启动监听推送消息事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnPushMessageCallbackResult](#onpushmessagecallbackresult-values)) => void | 是 | - | - |\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | \"click\" \\\\| \"receive\" | 是 | - | 事件类型
- click 从系统推送服务点击消息启动应用事件
- receive 应用从推送服务器接收到推送消息事件 |\n| data | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | 消息内容 |\n","returnValue":"","compatibility":"### onPushMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[onPushMessage](http://uniapp.dcloud.io/api/plugins/push.html#onpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.onPushMessage)\n"},"offPushMessage":{"name":"## uni.offPushMessage(callback) @offpushmessage","description":"关闭推送消息监听事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnPushMessageCallbackResult](#onpushmessagecallbackresult-values)) => void | 是 | - | - |\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | \"click\" \\\\| \"receive\" | 是 | - | 事件类型
- click 从系统推送服务点击消息启动应用事件
- receive 应用从推送服务器接收到推送消息事件 |\n| data | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | 消息内容 |\n","returnValue":"","compatibility":"### offPushMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[offPushMessage](http://uniapp.dcloud.io/api/plugins/push.html#offpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.offPushMessage)\n"},"getChannelManager":{"name":"## uni.getChannelManager() @getchannelmanager","description":"获取通知渠道管理器,Android 8系统以上才可以设置通知渠道,Android 8系统以下返回null。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [ChannelManager](#channelmanager-values) | \n\n#### ChannelManager 的方法 @channelmanager-values \n\n#### setPushChannel(options) @setpushchannel\n\n设置推送渠道\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetPushChannelOptions](#setpushchanneloptions-values) | 是 | - | - |\n###### SetPushChannelOptions 的属性值 @setpushchanneloptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| soundName | string | 否 | null | 添加的声音文件,注意raw目录下必须要有 ,不传此字段将使用默认铃音。 |\n| channelId | string | 是 | - | 通知渠道id |\n| channelDesc | string | 是 | - | 通知渠道描述 |\n| enableLights | boolean | 否 | false | 呼吸灯闪烁 |\n| enableVibration | boolean | 否 | false | 震动 |\n| importance | number | 否 | 3 | 通知的重要性级别,可选范围IMPORTANCE_LOW:2、IMPORTANCE_DEFAULT:3、IMPORTANCE_HIGH:4 。 |\n| lockscreenVisibility | number | 否 | -1000 | 锁屏可见性,可选范围VISIBILITY_PRIVATE:0、VISIBILITY_PUBLIC:1、VISIBILITY_SECRET:-1、VISIBILITY_NO_OVERRIDE:-1000。 |\n\n\n##### setPushChannel 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n\n\n#### getAllChannels() @getallchannels\n\n获取当前应用注册的所有的通知渠道。\n\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\ | \n\n##### getAllChannels 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n\n","compatibility":"### getChannelManager 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.getChannelManager)\n"},"createPushMessage":{"name":"## uni.createPushMessage(options) @createpushmessage","description":"创建本地通知栏消息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [CreatePushMessageOptions](#createpushmessageoptions-values) | 是 | - | - |\n#### CreatePushMessageOptions 的属性值 @createpushmessageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| cover | boolean | 否 | false | 是否覆盖上一次提示的消息 |\n| delay | number | 否 | 0 | 提示消息延迟显示的时间,单位为s |\n| icon | string | 否 | null | 推送消息的图标 |\n| sound | string | 否 | \"system\" | 推送消息的提示音 - system: 使用系统通知提示音(默认值) - none: 不使用提示音 |\n| title | string | 否 | App的名称 | 推送消息的标题 |\n| content | string | 是 | - | 消息显示的内容,在系统通知中心中显示的文本内容 |\n| payload | any | 否 | null | 消息承载的数据,可根据业务逻辑自定义数据格式 |\n| when | number | 否 | 当前时间 | 消息上显示的提示时间 |\n| channelId | string | 否 | \"DcloudChannelID\" | 渠道id |\n| category | string | 否 | null | 通知类别 |\n| success | (result: CreatePushMessageSuccess) => void | 否 | null | 接口调用成功的回调函数 |\n| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | null | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | null | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### CreatePushMessageOptions 兼容性 \n| | Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- | :- |\n| channelId | 4.4 | 3.98 | x | - |\n| category | 4.4 | 3.98 | x | - |\n","returnValue":"","compatibility":"### createPushMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[createPushMessage](http://uniapp.dcloud.io/api/plugins/push.html#createpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.createPushMessage)\n"},"getBatteryInfo":{"name":"## uni.getBatteryInfo(options) @getbatteryinfo","description":"获取电池电量信息\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetBatteryInfoOptions](#getbatteryinfooptions-values) | 是 | - | - |\n#### GetBatteryInfoOptions 的属性值 @getbatteryinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (res: [GetBatteryInfoSuccess](#getbatteryinfosuccess-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n| fail | (res: UniError) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用成功的回调 |\n\n##### GetBatteryInfoSuccess 的属性值 @getbatteryinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n| level | number | 是 | - | 设备电量,范围1 - 100 |\n| isCharging | boolean | 是 | - | 是否正在充电中 |\n","returnValue":"","compatibility":"### getBatteryInfo 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-battery-info.getBatteryInfo)\n"},"getBatteryInfoSync":{"name":"## uni.getBatteryInfoSync() @getbatteryinfosync","description":"获取电池电量信息\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetBatteryInfoResult](#getbatteryinforesult-values) | \n\n#### GetBatteryInfoResult 的属性值 @getbatteryinforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| level | number | 是 | - | 设备电量,范围1 - 100 |\n| isCharging | boolean | 是 | - | 是否正在充电中 |\n","compatibility":"### getBatteryInfoSync 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-battery-info.getBatteryInfoSync)\n"},"get-battery-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-battery-info/get-battery-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-battery-info/get-battery-info\n>Template\n```vue\n\r\n\t\r\n\t\t当前电量:{{level}}%\r\n\t\t是否充电中:{{isCharging}}\r\n\t\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n\texport default {\r\n\t\tdata() {\r\n\t\t\treturn {\r\n\t\t\t\tlevel: 0,\r\n\t\t\t\tisCharging: false\r\n\t\t\t}\r\n\t\t},\r\n\t\tonLoad() {\r\n\t\t\tuni.getBatteryInfo({\r\n\t\t\t\tsuccess: res => {\r\n\t\t\t\t\tthis.level = res.level;\r\n\t\t\t\t\tthis.isCharging = res.isCharging;\r\n\t\t\t\t}\r\n\t\t\t});\r\n\t\t}\r\n\t}\r\n\n```\n\n:::"},"startWifi":{"name":"## uni.startWifi(option) @startwifi","description":"\r\n初始化Wi-Fi模块\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | Wifi 函数通用入参封装 |\n#### WifiOption 的属性值 @wifioption-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - |\n| fail | (res: UniError) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | [UniWifiInfo](#uniwifiinfo-values) | 否 | - | - |\n\n###### UniWifiInfo 的属性值 @uniwifiinfo-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SSID | string | 是 | - | - |\n| BSSID | string | 否 | - | - |\n| secure | boolean | 否 | - | - |\n| signalStrength | number | 否 | - | - |\n| frequency | number | 否 | - | - |\n","returnValue":"","compatibility":"### startWifi 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[startWifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#startwifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.startWifi)\n"},"connectWifi":{"name":"## uni.connectWifi(option) @connectwifi","description":"","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [WifiConnectOption](#wificonnectoption-values) | 是 | - | Wifi 链接参数封装 |\n#### WifiConnectOption 的属性值 @wificonnectoption-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SSID | string | 否 | - | - |\n| BSSID | string | 否 | - | - |\n| password | string | 否 | - | - |\n| maunal | boolean | 否 | - | - |\n| partialInfo | boolean | 否 | - | - |\n| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - |\n| fail | (res: UniError) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | [UniWifiInfo](#uniwifiinfo-values) | 否 | - | - |\n\n###### UniWifiInfo 的属性值 @uniwifiinfo-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SSID | string | 是 | - | - |\n| BSSID | string | 否 | - | - |\n| secure | boolean | 否 | - | - |\n| signalStrength | number | 否 | - | - |\n| frequency | number | 否 | - | - |\n","returnValue":"","compatibility":"### connectWifi 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| >=4.4 && <10.0 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[connectWifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#connectWifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.connectWifi)\n"},"getWifiList":{"name":"## uni.getWifiList(option) @getwifilist","description":"\r\n请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | Wifi 函数通用入参封装 |\n#### WifiOption 的属性值 @wifioption-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - |\n| fail | (res: UniError) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | [UniWifiInfo](#uniwifiinfo-values) | 否 | - | - |\n\n###### UniWifiInfo 的属性值 @uniwifiinfo-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SSID | string | 是 | - | - |\n| BSSID | string | 否 | - | - |\n| secure | boolean | 否 | - | - |\n| signalStrength | number | 否 | - | - |\n| frequency | number | 否 | - | - |\n","returnValue":"","compatibility":"### getWifiList 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[getWifiList](https://uniapp.dcloud.net.cn/api/system/wifi.html#getWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.getWifiList)\n"},"onGetWifiList":{"name":"## uni.onGetWifiList(callback) @ongetwifilist","description":"\r\n监听获取到 Wi-Fi 列表数据事件。\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (wifiInfo: any) => void | 是 | - | - |","returnValue":"","compatibility":"### onGetWifiList 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[onGetWifiList](https://uniapp.dcloud.net.cn/api/system/wifi.html#onGetWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onGetWifiList)\n"},"offGetWifiList":{"name":"## uni.offGetWifiList(callback) @offgetwifilist","description":"\r\n移除获取到 Wi-Fi 列表数据事件的监听函数。\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | () => void | 是 | - | - |","returnValue":"","compatibility":"### offGetWifiList 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[offGetWifiList](https://uniapp.dcloud.net.cn/api/system/wifi.html#offGetWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.offGetWifiList)\n"},"getConnectedWifi":{"name":"## uni.getConnectedWifi(option) @getconnectedwifi","description":"\r\n获取已连接的 Wi-Fi 信息\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [GetConnectedWifiOptions](#getconnectedwifioptions-values) | 是 | - | 获取当前链接的wifi信息 |\n#### GetConnectedWifiOptions 的属性值 @getconnectedwifioptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| partialInfo | boolean | 否 | - | - |\n| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - |\n| fail | (res: UniError) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | [UniWifiInfo](#uniwifiinfo-values) | 否 | - | - |\n\n###### UniWifiInfo 的属性值 @uniwifiinfo-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SSID | string | 是 | - | - |\n| BSSID | string | 否 | - | - |\n| secure | boolean | 否 | - | - |\n| signalStrength | number | 否 | - | - |\n| frequency | number | 否 | - | - |\n","returnValue":"","compatibility":"### getConnectedWifi 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[getConnectedWifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#getConnectedWifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.getConnectedWifi)\n"},"onWifiConnected":{"name":"## uni.onWifiConnected(callback) @onwificonnected","description":"\r\n监听连接上 Wi-Fi 的事件\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (wifiInfo: [UniWifiResult](#uniwifiresult-values)) => void | 是 | - | - |\n#### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | [UniWifiInfo](#uniwifiinfo-values) | 否 | - | - |\n\n##### UniWifiInfo 的属性值 @uniwifiinfo-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SSID | string | 是 | - | - |\n| BSSID | string | 否 | - | - |\n| secure | boolean | 否 | - | - |\n| signalStrength | number | 否 | - | - |\n| frequency | number | 否 | - | - |\n","returnValue":"","compatibility":"### onWifiConnected 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[onWifiConnected](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnected)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onWifiConnected)\n"},"onWifiConnectedWithPartialInfo":{"name":"## uni.onWifiConnectedWithPartialInfo(callback) @onwificonnectedwithpartialinfo","description":"\r\n监听连接上 Wi-Fi 的事件。\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (wifiInfo: [UniWifiInfoWithPartialInfo](#uniwifiinfowithpartialinfo-values)) => void | 是 | - | - |\n#### UniWifiInfoWithPartialInfo 的属性值 @uniwifiinfowithpartialinfo-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SSID | string | 是 | - | - |\n","returnValue":"","compatibility":"### onWifiConnectedWithPartialInfo 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[onWifiConnectedWithPartialInfo](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnectedWithPartialInfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onWifiConnectedWithPartialInfo)\n"},"offWifiConnected":{"name":"## uni.offWifiConnected(callback?) @offwificonnected","description":"\r\n移除连接上 Wi-Fi 的事件的监听函数。\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | () => void | 否 | - | - |","returnValue":"","compatibility":"### offWifiConnected 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[offWifiConnected](https://uniapp.dcloud.net.cn/api/system/wifi.html#offWifiConnected)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.offWifiConnected)\n"},"onMemoryWarning":{"name":"## uni.onMemoryWarning(callback) @onmemorywarning","description":"\n开启监听内存警告\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-memorywarning](https://ext.dcloud.net.cn/plugin?name=uni-memorywarning)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (res: [MemoryWarningCallbackResult](#memorywarningcallbackresult-values)) => void | 是 | - | uni.onMemoryWarning/uni.offMemoryWarning回调函数定义 |\n#### MemoryWarningCallbackResult 的属性值 @memorywarningcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| level | number | 是 | - | 内存警告等级(仅安卓平台有效,iOS始终是0) |\n","returnValue":"","compatibility":"### onMemoryWarning 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[onMemoryWarning](https://uniapp.dcloud.net.cn/api/system/memory.html#onmemorywarning)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.memory.onMemoryWarning)\n"},"offMemoryWarning":{"name":"## uni.offMemoryWarning(callback?) @offmemorywarning","description":"\n取消监听内存不足告警事件\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-memorywarning](https://ext.dcloud.net.cn/plugin?name=uni-memorywarning)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (res: [MemoryWarningCallbackResult](#memorywarningcallbackresult-values)) => void | 否 | - | - |\n#### MemoryWarningCallbackResult 的属性值 @memorywarningcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| level | number | 是 | - | 内存警告等级(仅安卓平台有效,iOS始终是0) |\n","returnValue":"","compatibility":"### offMemoryWarning 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[offMemoryWarning](https://uniapp.dcloud.net.cn/api/system/memory.html#offmemorywarning)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.memory.offMemoryWarning)\n"},"onUserCaptureScreen":{"name":"## uni.onUserCaptureScreen(callback?) @onusercapturescreen","description":"\n开启截屏监听 \n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (res: [OnUserCaptureScreenCallbackResult](#onusercapturescreencallbackresult-values)) => void | 否 | - | - |\n#### OnUserCaptureScreenCallbackResult 的属性值 @onusercapturescreencallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string | 否 | - | 截屏文件路径(仅Android返回) |\n","returnValue":"","compatibility":"### onUserCaptureScreen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | 3.9.0 | - |\n","tutorial":"\n### 参见\n[onUserCaptureScreen](https://uniapp.dcloud.net.cn/api/system/capture-screen.html#onusercapturescreen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.captureScreen.onUserCaptureScreen)\n"},"offUserCaptureScreen":{"name":"## uni.offUserCaptureScreen(callback?) @offusercapturescreen","description":"\n关闭截屏监听 \n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (res: [OnUserCaptureScreenCallbackResult](#onusercapturescreencallbackresult-values)) => void | 否 | - | - |\n#### OnUserCaptureScreenCallbackResult 的属性值 @onusercapturescreencallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string | 否 | - | 截屏文件路径(仅Android返回) |\n","returnValue":"","compatibility":"### offUserCaptureScreen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | 3.9.0 | - |\n","tutorial":"\n### 参见\n[offUserCaptureScreen](https://uniapp.dcloud.net.cn/api/system/capture-screen.html#offusercapturescreen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.captureScreen.offUserCaptureScreen)\n"},"createRequestPermissionListener":{"name":"## uni.createRequestPermissionListener() @createrequestpermissionlistener","description":"创建一个监听权限申请的对象。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RequestPermissionListener](#requestpermissionlistener-values) | \n\n#### RequestPermissionListener 的方法 @requestpermissionlistener-values \n\n#### onRequest(callback) @onrequest\n\r\n监听申请系统权限\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (permissions: Array\\) => void | 是 | - | 申请系统权限回调,permissions为触发权限申请的所有权限 |\n\n\n\n#### onConfirm(callback) @onconfirm\n\r\n监听弹出系统权限授权框\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (permissions: Array\\) => void | 是 | - | 弹出系统权限授权框回调,permissions为触发弹出权限授权框的所有权限 |\n\n\n\n#### onComplete(callback) @oncomplete\n\r\n监听权限申请完成\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (permissions: Array\\) => void | 是 | - | 权限申请完成回调,permissions为申请完成的所有权限 |\n\n\n\n#### stop() @stop\n\r\n取消所有监听\n\n\n\n","compatibility":"### createRequestPermissionListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | - | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.createRequestPermissionListener)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/create-request-permission-listener/create-request-permission-listener.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n 访问日历权限申请说明:\r\n uni-app x正在申请访问日历权限用于演示,允许或拒绝均不会获取任何隐私信息。\r\n \r\n \r\n\r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"chooseImage":{"name":"## uni.chooseImage(options) @chooseimage","description":"从本地相册选择图片或使用相机拍照","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ChooseImageOptions](#chooseimageoptions-values) | 是 | - | - |\n#### ChooseImageOptions 的属性值 @chooseimageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| count | number | 否 | 9 | 最多可以选择的图片张数,app端不限制,微信小程序最多可支持20个。 |\n| sizeType | Array\\ | 否 | ['original','compressed'\\] | original 原图,compressed 压缩图,默认二者都有 |\n| sourceType | Array\\ | 否 | ['album','camera'\\] | album 从相册选图,camera 使用相机,默认二者都有 |\n| crop | [ChooseImageCropOptions](#chooseimagecropoptions-values) | 否 | - | 图像裁剪参数,设置后 sizeType 失效。 |\n| success | (callback: [ChooseImageSuccess](#chooseimagesuccess-values)) => void | 否 | - | 成功则返回图片的本地文件路径列表 tempFilePaths |\n| fail | (callback: [IMediaError](#imediaerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (callback: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### ChooseImageCropOptions 的属性值 @chooseimagecropoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| width | number | 是 | - | 裁剪的宽度,单位为px,用于计算裁剪宽高比。 |\n| height | number | 是 | - | 裁剪的高度,单位为px,用于计算裁剪宽高比。 |\n| quality | number | 否 | 80 | 取值范围为1-100,数值越小,质量越低(仅对jpg格式有效)。默认值为80。 |\n| resize | boolean | 否 | - | 是否将width和height作为裁剪保存图片真实的像素值。默认值为true。注:设置为false时在裁剪编辑界面显示图片的像素值,设置为true时不显示。 |\n\n##### ChooseImageSuccess 的属性值 @chooseimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errSubject | string | 是 | - | 调用API的名称 |\n| errMsg | string | 是 | - | 描述信息 |\n| tempFilePaths | Array\\ | 是 | - | 图片的本地文件路径列表 |\n| tempFiles | any | 是 | - | 图片的本地文件列表 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 1101001 \\\\| 1101002 \\\\| 1101003 \\\\| 1101004 \\\\| 1101005 \\\\| 1101006 \\\\| 1101007 \\\\| 1101008 \\\\| 1101009 \\\\| 1101010 | 是 | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"","compatibility":"### chooseImage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | - | 4.0 |\n","tutorial":"\n### 参见\n[chooseImage](http://uniapp.dcloud.io/api/media/image?id=chooseimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.choose-image)\n"},"choose-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/choose-image/choose-image.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/choose-image/choose-image\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 图片来源\r\n \r\n \r\n {{sourceType[sourceTypeIndex]}}\r\n \r\n \r\n\r\n \r\n \r\n 图片质量\r\n \r\n \r\n {{sizeType[sizeTypeIndex]}}\r\n \r\n \r\n\r\n \r\n \r\n 数量限制\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 图像裁剪\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 图片质量(%)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 裁剪宽度(px)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 裁剪高度(px)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 保留原宽高\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n 点击可预览选好的图片\r\n \r\n {{imageList.length}}/{{countIndex+1}}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n var sourceTypeArray = [\r\n ['camera'],\r\n ['album'],\r\n ['camera', 'album']\r\n ]\r\n var sizeTypeArray = [\r\n ['compressed'],\r\n ['original'],\r\n ['compressed', 'original']\r\n ]\r\n export default {\r\n data() {\r\n return {\r\n title: 'choose/previewImage',\r\n imageList: [] as Array,\r\n sourceTypeIndex: 2,\r\n sourceType: ['拍照', '相册', '拍照或相册'],\r\n sizeTypeIndex: 2,\r\n sizeType: ['压缩', '原图', '压缩或原图'],\r\n countIndex: 8,\r\n count: [1, 2, 3, 4, 5, 6, 7, 8, 9],\r\n isCrop: false,\r\n cropPercent: 80,\r\n cropWidth: 100,\r\n cropHeight: 100,\r\n cropResize: false\r\n }\r\n },\r\n onUnload() {\r\n this.imageList = [];\r\n this.sourceTypeIndex = 2\r\n this.sourceType = ['拍照', '相册', '拍照或相册']\r\n this.sizeTypeIndex = 2\r\n this.sizeType = ['压缩', '原图', '压缩或原图']\r\n this.countIndex = 8\r\n },\r\n methods: {\r\n cropHeightConfim(e : InputConfirmEvent) {\r\n let value = parseInt(e.detail.value)\r\n if (value > 0) {\r\n this.cropHeight = value\r\n } else {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"裁剪高度需要大于0\"\r\n })\r\n }\r\n },\r\n cropWidthConfim(e : InputConfirmEvent) {\r\n let value = parseInt(e.detail.value)\r\n if (value > 0) {\r\n this.cropWidth = value\r\n } else {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"裁剪宽度需要大于0\"\r\n })\r\n }\r\n },\r\n cropPercentConfim(e : InputConfirmEvent) {\r\n let value = parseInt(e.detail.value)\r\n if (value > 0 && value <= 100) {\r\n this.cropPercent = value\r\n } else {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"请输入0~100之间的值\"\r\n })\r\n }\r\n },\r\n cropResizeChange(e : UniSwitchChangeEvent) {\r\n this.cropResize = e.detail.value\r\n },\r\n switchCrop(e : UniSwitchChangeEvent) {\r\n this.isCrop = e.detail.value\r\n },\r\n removeImage(index : number) {\r\n this.imageList.splice(index, 1)\r\n },\r\n chooseImageSource() {\r\n uni.showActionSheet({\r\n itemList: ['拍照', '相册', '拍照或相册'],\r\n success: (e) => {\r\n this.sourceTypeIndex = e.tapIndex!\r\n }\r\n })\r\n },\r\n chooseImageType() {\r\n uni.showActionSheet({\r\n itemList: ['压缩', '原图', '压缩或原图'],\r\n success: (e) => {\r\n this.sizeTypeIndex = e.tapIndex!\r\n }\r\n })\r\n },\r\n chooseImageCount(event : InputConfirmEvent) {\r\n let count = parseInt(event.detail.value) - 1\r\n if (count < 0) {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"图片数量应该大于0\"\r\n })\r\n return\r\n }\r\n this.countIndex = count\r\n },\r\n chooseImage: function () {\r\n // var cropOption:ChooseImageCropOptions|null = this.isCrop ? null : new ChooseImageCropOptions( )\r\n if (this.imageList.length >= 9) {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"已经有9张图片了,请删除部分图片之后重新选择\"\r\n })\r\n return\r\n }\r\n uni.chooseImage({\r\n sourceType: sourceTypeArray[this.sourceTypeIndex],\r\n sizeType: sizeTypeArray[this.sizeTypeIndex],\r\n crop: this.isCrop ? { \"quality\": this.cropPercent, \"width\": this.cropWidth, \"height\": this.cropHeight, \"resize\": this.cropResize } as ChooseImageCropOptions : null,\r\n count: this.imageList.length + this.count[this.countIndex] > 9 ? 9 - this.imageList.length : this.count[this.countIndex],\r\n success: (res) => {\r\n this.imageList = this.imageList.concat(res.tempFilePaths);\r\n },\r\n fail: (err) => {\r\n console.log(\"err: \", JSON.stringify(err));\r\n }\r\n })\r\n },\r\n previewImage: function (index : number) {\r\n uni.previewImage({\r\n current: index,\r\n urls: this.imageList\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"previewImage":{"name":"## uni.previewImage(options) @previewimage","description":"预览图片","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [PreviewImageOptions](#previewimageoptions-values) | 是 | - | - |\n#### PreviewImageOptions 的属性值 @previewimageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| current | any | 否 | - | current 为当前显示图片的链接/索引值,不填或填写的值无效则为 urls 的第一张。 |\n| urls | Array\\ | 是 | - | 需要预览的图片链接列表 |\n| indicator | string | 否 | - | 图片指示器样式 - default: 底部圆点指示器 - number: 顶部数字指示器 - none: 不显示指示器 |\n| loop | boolean | 否 | - | 是否可循环预览 |\n| success | (callback: [PreviewImageSuccess](#previewimagesuccess-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (callback: [IMediaError](#imediaerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (callback: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### PreviewImageSuccess 的属性值 @previewimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errSubject | string | 是 | - | 调用API的名称 |\n| errMsg | string | 是 | - | 描述信息 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 1101001 \\\\| 1101002 \\\\| 1101003 \\\\| 1101004 \\\\| 1101005 \\\\| 1101006 \\\\| 1101007 \\\\| 1101008 \\\\| 1101009 \\\\| 1101010 | 是 | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"","compatibility":"### previewImage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | - | 4.0 |\n","tutorial":"\n### 参见\n[previewImage](http://uniapp.dcloud.io/api/media/image?id=previewimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.preview-image.previewImage)\n"},"closePreviewImage":{"name":"## uni.closePreviewImage(options) @closepreviewimage","description":"关闭图片预览","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ClosePreviewImageOptions](#closepreviewimageoptions-values) | 是 | - | - |\n#### ClosePreviewImageOptions 的属性值 @closepreviewimageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (callback: [ClosePreviewImageSuccess](#closepreviewimagesuccess-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (callback: [IMediaError](#imediaerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (callback: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### ClosePreviewImageSuccess 的属性值 @closepreviewimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | 错误信息 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 1101001 \\\\| 1101002 \\\\| 1101003 \\\\| 1101004 \\\\| 1101005 \\\\| 1101006 \\\\| 1101007 \\\\| 1101008 \\\\| 1101009 \\\\| 1101010 | 是 | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"","compatibility":"### closePreviewImage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | - | - |\n","tutorial":"\n### 参见\n[closePreviewImage](http://uniapp.dcloud.io/api/media/image?id=closepreviewimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.preview-image.closePreviewImage)\n"},"preview-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/preview-image/preview-image.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/preview-image/preview-image\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n 图片指示器样式\r\n \r\n \r\n {{\r\n item.name\r\n }}\r\n \r\n \r\n \r\n \r\n \r\n 循环播放\r\n \r\n \r\n \r\n 点击图片开始预览\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n imageList: [\"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni@2x.png\", \"/static/uni.png\"],\r\n indicator: [{\r\n value: \"default\",\r\n name: \"圆点\"\r\n }, {\r\n value: \"number\",\r\n name: \"数字\"\r\n }, {\r\n value: \"none\",\r\n name: \"不显示\"\r\n }] as ItemType[],\r\n currentIndicator: \"default\",\r\n isLoop: true\r\n }\r\n },\r\n methods: {\r\n previewImage(index : number) {\r\n uni.previewImage({\r\n urls: this.imageList,\r\n current: index,\r\n indicator: this.currentIndicator,\r\n loop: this.isLoop\r\n })\r\n },\r\n chooseImage() {\r\n uni.chooseImage({\r\n sourceType: ['album'],\r\n success: (e) => {\r\n this.imageList = this.imageList.concat(e.tempFilePaths)\r\n },\r\n fail(_) {\r\n }\r\n })\r\n },\r\n onIndicatorChanged(e : UniRadioGroupChangeEvent) {\r\n this.currentIndicator = e.detail.value\r\n },\r\n onCheckboxChange(_ : UniCheckboxGroupChangeEvent) {\r\n this.isLoop = !this.isLoop\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"saveImageToPhotosAlbum":{"name":"## uni.saveImageToPhotosAlbum(options) @saveimagetophotosalbum","description":"保存图片到系统相册","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SaveImageToPhotosAlbumOptions](#saveimagetophotosalbumoptions-values) | 是 | - | - |\n#### SaveImageToPhotosAlbumOptions 的属性值 @saveimagetophotosalbumoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string.ImageURIString | 是 | - | 图片文件路径,可以是临时文件路径也可以是永久文件路径,不支持网络图片路径 |\n| success | (callback: [SaveImageToPhotosAlbumSuccess](#saveimagetophotosalbumsuccess-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (callback: [IMediaError](#imediaerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (callback: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SaveImageToPhotosAlbumSuccess 的属性值 @saveimagetophotosalbumsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string | 是 | - | 保存到相册的图片路径 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 1101001 \\\\| 1101002 \\\\| 1101003 \\\\| 1101004 \\\\| 1101005 \\\\| 1101006 \\\\| 1101007 \\\\| 1101008 \\\\| 1101009 \\\\| 1101010 | 是 | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"","compatibility":"### saveImageToPhotosAlbum 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | - | - |\n","tutorial":"\n### 参见\n[saveImageToPhotosAlbum](http://uniapp.dcloud.io/api/media/image?id=saveimagetophotosalbum)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.save-image-to-photos-album)\n"},"save-image-to-photos-album":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/save-image-to-photos-album/save-image-to-photos-album.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"getLocation":{"name":"## uni.getLocation(options) @getlocation","description":"获取当前的地理位置、速度","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetLocationOptions](#getlocationoptions-values) | 是 | - | - |\n#### GetLocationOptions 的属性值 @getlocationoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | \"gps\" \\\\| \"gcj02\" | 否 | wgs84 | 默认为 wgs84 返回 gps 坐标,gcj02 返回可用于uni.openLocation的坐标 |\n| altitude | boolean | 否 | false | 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 |\n| geocode | boolean | 否 | false | 传入 true 会解析地址 |\n| highAccuracyExpireTime | number | 否 | 3000 | 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 |\n| isHighAccuracy | boolean | 否 | false | 开启高精度定位 |\n| success | (result: [GetLocationSuccess](#getlocationsuccess-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [IGetLocationFail](#igetlocationfail-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### GetLocationSuccess 的属性值 @getlocationsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| latitude | number | 是 | 0 | 纬度,浮点数,范围为-90~90,负数表示南纬 |\n| longitude | number | 是 | 0 | 经度,范围为-180~180,负数表示西经 |\n| speed | number | 是 | 0 | 速度,浮点数,单位m/s |\n| accuracy | number | 是 | - | 位置的精确度 |\n| altitude | number | 是 | 0 | 高度,单位 m |\n| verticalAccuracy | number | 是 | 0 | 垂直精度,单位 m(Android 无法获取,返回 0) |\n| horizontalAccuracy | number | 是 | 0 | 水平精度,单位 m |\n| address | any | 否 | null | 地址信息 |\n\n##### IGetLocationFail 的属性值 @igetlocationfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 1505004 \\\\| 1505021 \\\\| 1505022 \\\\| 1505023 \\\\| 1505024 | 是 | - | 错误码
- 1505004 缺失权限
- 1505021 超时
- 1505022 不支持的定位类型
- 1505023 不支持逆地理编码
- 1505024 没有找到具体的定位引擎,请定位开关是否已打开 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n","returnValue":"","compatibility":"### getLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | x | 4.0 |\n","tutorial":"\n### 参见\n[getLocation]([](http://uniapp.dcloud.io/api/location/location?id=getlocation))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.location.get-location)\n"},"get-location":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-location/get-location.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-location/get-location\n>Template\n```vue\n\r\n \r\n \r\n \r\n 定位功能默认调用操作系统定位API实现。\\n\r\n 部分手机因gms兼容不好可能导致无法定位。\\n\r\n gcj国标、逆地理信息等功能需三方sdk定位。如果需要类似能力可以下载腾讯定位插件,打包自定义基座。参考示例:\r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n {{item.name}}\r\n \r\n \r\n \r\n \r\n 高度信息\r\n \r\n \r\n \r\n 开启高精度定位\r\n \r\n \r\n \r\n 是否解析地址信息\r\n \r\n \r\n {{exeRet}}\r\n \r\n \r\n \r\n \r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'get-location',\r\n altitudeSelect: false,\r\n isHighAccuracySelect: false,\r\n geocodeSelect: false,\r\n exeRet: '',\r\n items: [\r\n {\r\n value: 'wgs84',\r\n name: 'wgs84'\r\n },\r\n {\r\n value: 'gcj02',\r\n name: 'gcj02'\r\n }\r\n ] as ItemType[],\r\n current: 0,\r\n }\r\n },\r\n methods: {\r\n altitudeChange: function (e : UniSwitchChangeEvent) {\r\n this.altitudeSelect = e.detail.value\r\n },\r\n geocodeChange: function (e : UniSwitchChangeEvent) {\r\n this.geocodeSelect = e.detail.value\r\n },\r\n highAccuracySelectChange: function (e : UniSwitchChangeEvent) {\r\n this.isHighAccuracySelect = e.detail.value\r\n },\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n for (let i = 0; i < this.items.length; i++) {\r\n if (this.items[i].value === e.detail.value) {\r\n this.current = i;\r\n break;\r\n }\r\n }\r\n },\r\n getLocationTap: function () {\r\n uni.showLoading({\r\n title: '定位中'\r\n })\r\n uni.getLocation(({\r\n type: this.items[this.current].value,\r\n altitude: this.altitudeSelect,\r\n isHighAccuracy: this.isHighAccuracySelect,\r\n geocode: this.geocodeSelect,\r\n success: (res : any) => {\r\n uni.hideLoading()\r\n console.log(res);\r\n this.exeRet = JSON.stringify(res)\r\n },\r\n fail: (res : any) => {\r\n uni.hideLoading()\r\n console.log(res);\r\n this.exeRet = JSON.stringify(res)\r\n },\r\n complete: (res : any) => {\r\n uni.hideLoading()\r\n console.log(res);\r\n this.exeRet = JSON.stringify(res)\r\n }\r\n }));\r\n\r\n\r\n }\r\n\r\n }\r\n }\r\n\n```\n\n:::"},"getStorageInfo":{"name":"## uni.getStorageInfo(options) @getstorageinfo","description":"\r\nuni.getStorageInfo函数定义\r\n异步获取当前 storage 的相关信息。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetStorageInfoOptions](#getstorageinfooptions-values) | 是 | - | uni.getStorageInfo参数定义 |\n#### GetStorageInfoOptions 的属性值 @getstorageinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (res: [GetStorageInfoSuccess](#getstorageinfosuccess-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### GetStorageInfoSuccess 的属性值 @getstorageinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| keys | Array\\ | 是 | - | 当前 storage 中所有的 key |\n| currentSize | number | 是 | - | 当前占用的空间大小, 单位:kb |\n| limitSize | number | 是 | - | 限制的空间大小, 单位:kb |\n","returnValue":"","compatibility":"### getStorageInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[getStorageInfo](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageInfo)\n"},"getStorageInfoSync":{"name":"## uni.getStorageInfoSync() @getstorageinfosync","description":"\r\nuni.getStorageInfoSync函数定义\r\n同步获取当前 storage 的相关信息。\r\n\r\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetStorageInfoSuccess](#getstorageinfosuccess-values) | \n\n#### GetStorageInfoSuccess 的属性值 @getstorageinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| keys | Array\\ | 是 | - | 当前 storage 中所有的 key |\n| currentSize | number | 是 | - | 当前占用的空间大小, 单位:kb |\n| limitSize | number | 是 | - | 限制的空间大小, 单位:kb |\n","compatibility":"### getStorageInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[getStorageInfoSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfosync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageInfoSync)\n"},"getStorage":{"name":"## uni.getStorage(options) @getstorage","description":"\r\nuni.getStorage函数定义\r\n从本地存储中异步获取指定 key 对应的内容。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetStorageOptions](#getstorageoptions-values) | 是 | - | uni.getStorage参数定义 |\n#### GetStorageOptions 的属性值 @getstorageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |\n| success | (res: [GetStorageSuccess](#getstoragesuccess-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### GetStorageSuccess 的属性值 @getstoragesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | any | 否 | - | key 对应的内容 |\n","returnValue":"","compatibility":"### getStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[getStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorage)\n"},"getStorageSync":{"name":"## uni.getStorageSync(key) @getstoragesync","description":"\r\nuni.getStorageSync函数定义\r\n从本地存储中同步获取指定 key 对应的内容。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any | 否 | \n","compatibility":"### getStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[getStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageSync)\n"},"setStorage":{"name":"## uni.setStorage(options) @setstorage","description":"\r\nuni.setStorage函数定义\r\n将数据存储在本地storage存储中指定的 key 中,会覆盖掉原来该 key 对应的内容,这是一个异步接口。 \r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetStorageOptions](#setstorageoptions-values) | 是 | - | uni.setStorage参数定义 |\n#### SetStorageOptions 的属性值 @setstorageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |\n| data | any | 是 | - | 需要存储的内容,只支持原生类型、及能够通过 JSON.stringify 序列化的对象 |\n| success | (res: SetStorageSuccess) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n","returnValue":"","compatibility":"### setStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[setStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.setStorage)\n"},"setStorageSync":{"name":"## uni.setStorageSync(key, data) @setstoragesync","description":"\r\nuni.setStorageSync函数定义\r\n将 data 存储在本地storage存储中指定的 key 中,会覆盖掉原来该 key 对应的内容,这是一个同步接口。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地storage存储中的指定的 key |\n| data | any | 是 | - | 需要存储的内容,只支持原生类型、及能够通过 JSON.stringify 序列化的对象 |","returnValue":"","compatibility":"### setStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[setStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.setStorageSync)\n"},"removeStorage":{"name":"## uni.removeStorage(options) @removestorage","description":"\r\nuni.removeStorage函数定义\r\n从本地存储中异步移除指定 key。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RemoveStorageOptions](#removestorageoptions-values) | 是 | - | uni.removeStorage参数定义 |\n#### RemoveStorageOptions 的属性值 @removestorageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |\n| success | (res: RemoveStorageSuccess) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n","returnValue":"","compatibility":"### removeStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[removeStorage](hhttps://uniapp.dcloud.net.cn/api/storage/storage.html#removestorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.removeStorage)\n"},"removeStorageSync":{"name":"## uni.removeStorageSync(key) @removestoragesync","description":"\r\nuni.removeStorageSync函数定义\r\n从本地存储中同步移除指定 key。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |","returnValue":"","compatibility":"### removeStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[removeStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#removestoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.removeStorageSync)\n"},"clearStorage":{"name":"## uni.clearStorage(option?) @clearstorage","description":"\r\nuni.clearStorage函数定义\r\n清除本地数据存储。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [ClearStorageOptions](#clearstorageoptions-values) | 否 | - | - |\n#### ClearStorageOptions 的属性值 @clearstorageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (res: ClearStorageSuccess) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n","returnValue":"","compatibility":"### clearStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[clearStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.clearStorage)\n"},"clearStorageSync":{"name":"## uni.clearStorageSync() @clearstoragesync","description":"\r\nuni.clearStorageSync函数定义\r\n清除本地数据存储。\r\n","param":"","returnValue":"","compatibility":"### clearStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[clearStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.clearStorageSync)\n"},"storage":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/storage/storage.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/storage/storage\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n key\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n value\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{ storageInfo }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'get/set/clearStorage',\r\n key: '',\r\n data: '' as any,\r\n apiGetData: '' as any | null,\r\n storageInfo: '',\r\n }\r\n },\r\n methods: {\r\n getStorageInfo() {\r\n uni.getStorageInfo({\r\n success: (res) => {\r\n this.apiGetData = res\r\n this.storageInfo = JSON.stringify(res)\r\n },\r\n })\r\n },\r\n getStorageInfoSync() {\r\n try {\r\n const res = uni.getStorageInfoSync()\r\n this.apiGetData = res\r\n this.storageInfo = JSON.stringify(res)\r\n } catch (e) {\r\n // error\r\n console.log(e)\r\n }\r\n },\r\n jsonLikeMock() {\r\n this.key = 'key_' + Math.random()\r\n this.data = JSON.stringify({\r\n name: \"james\",\r\n age: 12,\r\n from: \"american\"\r\n });\r\n },\r\n strMock() {\r\n this.key = 'key_' + Math.random()\r\n this.data = '测试字符串数据,长度为16个字符'\r\n },\r\n complexMock() {\r\n this.key = 'key_' + Math.random()\r\n let jsonObj = {\r\n name: '张三',\r\n age: 12,\r\n classMate: [\r\n {\r\n id: 1001,\r\n name: '李四',\r\n },\r\n {\r\n id: 1002,\r\n name: 'jack ma',\r\n },\r\n ],\r\n }\r\n this.data = jsonObj\r\n },\r\n numberMock() {\r\n this.key = 'key_' + Math.random()\r\n this.data = 10011\r\n },\r\n floatMock() {\r\n this.key = 'key_' + Math.random()\r\n this.data = 3.1415926535893384626\r\n },\r\n\r\n keyChange: function (e : InputEvent) {\r\n this.key = e.detail.value\r\n },\r\n dataChange: function (e : InputEvent) {\r\n this.data = e.detail.value\r\n },\r\n getStorage: function () {\r\n var key = this.key\r\n if (key.length == 0) {\r\n uni.showModal({\r\n title: '读取数据失败',\r\n content: 'key 不能为空',\r\n showCancel: false,\r\n })\r\n } else {\r\n let that = this\r\n uni.getStorage({\r\n key: key,\r\n success: (res) => {\r\n\r\n that.apiGetData = res.data\r\n let desc : string = typeof this.apiGetData\r\n if (\"object\" == desc) {\r\n desc = desc + \": \" + JSON.stringify(this.apiGetData)\r\n } else {\r\n desc = desc + \": \" + this.apiGetData\r\n }\r\n\r\n uni.showModal({\r\n title: '读取数据成功',\r\n content: desc,\r\n showCancel: false,\r\n })\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n title: '读取数据失败',\r\n content: '找不到 key 对应的数据',\r\n showCancel: false,\r\n })\r\n },\r\n })\r\n }\r\n },\r\n getStorageSync: function () {\r\n var key = this.key\r\n if (key.length == 0) {\r\n uni.showModal({\r\n title: '读取数据失败',\r\n content: 'key 不能为空',\r\n showCancel: false,\r\n })\r\n } else {\r\n this.apiGetData = uni.getStorageSync(key)\r\n\r\n let desc : string = typeof this.apiGetData\r\n if (\"object\" == desc) {\r\n desc = desc + \": \" + JSON.stringify(this.apiGetData)\r\n } else {\r\n desc = desc + \": \" + this.apiGetData\r\n }\r\n\r\n uni.showModal({\r\n title: '读取数据成功',\r\n content: desc,\r\n showCancel: false,\r\n })\r\n }\r\n },\r\n setStorage: function () {\r\n var key = this.key\r\n var data = this.data\r\n if (key.length == 0) {\r\n uni.showModal({\r\n title: '保存数据失败',\r\n content: 'key 不能为空',\r\n showCancel: false,\r\n })\r\n } else {\r\n uni.setStorage({\r\n key: key,\r\n data: data,\r\n success: () => {\r\n uni.showModal({\r\n title: '存储数据成功',\r\n showCancel: false,\r\n })\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n title: '储存数据失败!',\r\n showCancel: false,\r\n })\r\n },\r\n })\r\n }\r\n },\r\n setStorageSync: function () {\r\n var key = this.key\r\n var data = this.data\r\n if (key.length == 0) {\r\n uni.showModal({\r\n title: '保存数据失败',\r\n content: 'key 不能为空',\r\n showCancel: false,\r\n })\r\n } else {\r\n uni.setStorageSync(key, data)\r\n uni.showModal({\r\n title: '存储数据成功',\r\n showCancel: false,\r\n })\r\n }\r\n },\r\n removeStorage: function () {\r\n uni.removeStorage({\r\n key: this.key,\r\n success: () => {\r\n uni.showModal({\r\n title: '移除数据成功',\r\n showCancel: false,\r\n })\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n title: '移除数据失败',\r\n showCancel: false,\r\n })\r\n },\r\n })\r\n },\r\n removeStorageSync: function () {\r\n uni.removeStorageSync(this.key)\r\n uni.showModal({\r\n title: '移除数据成功',\r\n showCancel: false,\r\n })\r\n },\r\n clearStorage: function () {\r\n this.key = ''\r\n this.data = ''\r\n uni.clearStorage({\r\n success: function (_) {\r\n uni.showModal({\r\n title: '清除数据成功',\r\n showCancel: false,\r\n })\r\n },\r\n fail: function (_) {\r\n uni.showModal({\r\n title: '清除数据失败',\r\n showCancel: false,\r\n })\r\n },\r\n })\r\n },\r\n clearStorageSync: function () {\r\n this.key = ''\r\n this.data = ''\r\n uni.clearStorageSync()\r\n uni.showModal({\r\n title: '清除数据成功',\r\n content: ' ',\r\n showCancel: false,\r\n })\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"getFileSystemManager":{"name":"## uni.getFileSystemManager() @getfilesystemmanager","description":"\r\n获取文件管理器","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [FileSystemManager](#filesystemmanager-values) | \n\n#### FileSystemManager 的方法 @filesystemmanager-values \n\n#### readFile(options) @readfile\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ReadFileOptions](#readfileoptions-values) | 是 | - | - |\n###### ReadFileOptions 的属性值 @readfileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| encoding | \"base64\" \\\\| \"utf-8\" | 是 | - | base64 / utf-8 |\n| filePath | string.URIString | 是 | - | 文件路径,支持相对地址和绝对地址 |\n| success | (res: [ReadFileSuccessResult](#readfilesuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n###### ReadFileSuccessResult 的属性值 @readfilesuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | string | 是 | - | - |\n\n\n\n\n#### writeFile(options) @writefile\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [WriteFileOptions](#writefileoptions-values) | 是 | - | - |\n###### WriteFileOptions 的属性值 @writefileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string.URIString | 是 | - | 文件路径,只支持绝对地址 |\n| encoding | \"ascii\" \\\\| \"base64\" \\\\| \"utf-8\" | 是 | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 |\n| data | string | 是 | - | 写入的文本内容 |\n| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n###### FileManagerSuccessResult 的属性值 @filemanagersuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n\n\n\n#### unlink(options) @unlink\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UnLinkOptions](#unlinkoptions-values) | 是 | - | - |\n###### UnLinkOptions 的属性值 @unlinkoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string.URIString | 是 | - | 文件路径,只支持绝对地址 |\n| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n\n\n\n#### mkdir(options) @mkdir\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [MkDirOptions](#mkdiroptions-values) | 是 | - | - |\n###### MkDirOptions 的属性值 @mkdiroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| dirPath | string.URIString | 是 | - | 创建的目录路径 (本地路径) |\n| recursive | boolean | 是 | - | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 |\n| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n\n\n\n#### rmdir(options) @rmdir\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RmDirOptions](#rmdiroptions-values) | 是 | - | - |\n###### RmDirOptions 的属性值 @rmdiroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| dirPath | string.URIString | 是 | - | 要删除的目录路径 (本地路径) |\n| recursive | boolean | 是 | - | 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。 |\n| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n\n\n\n#### readdir(options) @readdir\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ReadDirOptions](#readdiroptions-values) | 是 | - | - |\n###### ReadDirOptions 的属性值 @readdiroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| dirPath | string.URIString | 是 | - | 要读取的目录路径 (本地路径) |\n| success | (res: [ReadDirSuccessResult](#readdirsuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n###### ReadDirSuccessResult 的属性值 @readdirsuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| files | Array\\ | 是 | - | - |\n\n\n\n\n#### access(options) @access\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [AccessOptions](#accessoptions-values) | 是 | - | - |\n###### AccessOptions 的属性值 @accessoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string.URIString | 是 | - | 要删除的目录路径 (本地路径) |\n| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n\n\n\n#### rename(options) @rename\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RenameOptions](#renameoptions-values) | 是 | - | - |\n###### RenameOptions 的属性值 @renameoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| oldPath | string.URIString | 是 | - | 源文件路径,支持本地路径 |\n| newPath | string.URIString | 是 | - | 新文件路径,支持本地路径 |\n| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n\n\n\n#### copyFile(options) @copyfile\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [CopyFileOptions](#copyfileoptions-values) | 是 | - | - |\n###### CopyFileOptions 的属性值 @copyfileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| srcPath | string.URIString | 是 | - | 源文件路径,支持本地路径 |\n| destPath | string.URIString | 是 | - | 新文件路径,支持本地路径 |\n| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n\n\n\n#### getFileInfo(options) @getfileinfo\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetFileInfoOptions](#getfileinfooptions-values) | 是 | - | - |\n###### GetFileInfoOptions 的属性值 @getfileinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string.URIString | 是 | - | 要读取的文件路径 (本地路径) |\n| digestAlgorithm | \"md5\" \\\\| \"sha1\" | 是 | - | md5 / sha1 |\n| success | (res: [GetFileInfoSuccessResult](#getfileinfosuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n###### GetFileInfoSuccessResult 的属性值 @getfileinfosuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| digest | string | 是 | - | - |\n| size | number | 是 | - | - |\n| errMsg | string | 是 | - | - |\n\n\n\n\n#### stat(options) @stat\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [StatOptions](#statoptions-values) | 是 | - | - |\n###### StatOptions 的属性值 @statoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string.URIString | 是 | - | 文件/目录路径 (本地路径) |\n| recursive | boolean | 是 | - | 是否递归获取目录下的每个文件的 Stats 信息 |\n| success | (res: [StatSuccessResult](#statsuccessresult-values)) => void | 否 | - | 接口调用的回调函数 |\n| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n###### StatSuccessResult 的属性值 @statsuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n| stats | Array\\<[FileStats](#filestats-values)\\> | 是 | - | - |\n\n###### FileStats 的属性值 @filestats-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string | 是 | - | - |\n| stats | [Stats](#stats-values) | 是 | - | - |\n\n###### Stats 的属性值 @stats-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| mode | number | 是 | - | - |\n| size | number | 是 | - | - |\n| lastAccessedTime | number | 是 | - | - |\n| lastModifiedTime | number | 是 | - | - |\n| mIsFile | boolean | 是 | - | - |\n\n###### Stats 的方法 @stats-values \n\n##### isDirectory() @isdirectory\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean | \n\n\n\n##### isFile() @isfile\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean | \n\n\n\n##### toLog() @tolog\n\n\n###### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any | 否 | \n\n\n\n##### toJSON() @tojson\n\n\n###### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any | 否 | \n\n\n\n\n\n","compatibility":"### getFileSystemManager 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.file.filemanager.getFileSystemManager)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-file-system-manager/get-file-system-manager.uvue) \n ```vue\n\r\n \r\n \r\n \r\n 显示简易操作日志,详细日志需真机运行查看\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"getUniverifyManager":{"name":"## uni.getUniverifyManager() @getuniverifymanager","description":"获取一键登录管理对象","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniverifyManager](#univerifymanager-values) | \n\n#### UniverifyManager 的方法 @univerifymanager-values \n\n#### preLogin(options) @prelogin\n预登录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [PreLoginOptions](#preloginoptions-values) | 是 | - | 预登录参数 |\n###### PreLoginOptions 的属性值 @preloginoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | () => void | 否 | - | - |\n| fail | (err: [PreLoginFail](#preloginfail-values)) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n###### PreLoginFail 的属性值 @preloginfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 1000 \\\\| 1001 \\\\| 1002 \\\\| 1004 \\\\| 4001 \\\\| 30004 \\\\| 30005 \\\\| 30006 | 是 | - | 1000 当前应用appid尚未开通uni一键登录
1001 应用所有者账号信息异常,请检查账号一键登录服务是否正常
1002 应用所有者账号信息异常,请检查账号余额是否充足
1004 uni一键登录应用不存在
4001 参数异常
30004 其他错误
30005 预登录失败
30006 一键登录失败 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n\n##### preLogin 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n\n\n#### login(options) @login\n登录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [LoginOptions](#loginoptions-values) | 是 | - | 登录参数 |\n###### LoginOptions 的属性值 @loginoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| univerifyStyle | [UniverifyStyle](#univerifystyle-values) | 否 | - | 登录页样式 |\n| success | (res: [LoginSuccess](#loginsuccess-values)) => void | 否 | - | - |\n| fail | (err: [LoginFail](#loginfail-values)) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n###### UniverifyStyle 的属性值 @univerifystyle-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fullScreen | boolean | 否 | - | 是否全屏 |\n| logoPath | string | 否 | - | logo路径 |\n| backgroundColor | string | 否 | - | 登录页背景色 |\n| loginBtnText | string | 否 | - | 登录按钮文字 |\n\n###### LoginSuccess 的属性值 @loginsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| openId | string | 是 | - | 登录授权唯一标识 |\n| accessToken | string | 是 | - | token |\n\n###### LoginFail 的属性值 @loginfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 1000 \\\\| 1001 \\\\| 1002 \\\\| 1004 \\\\| 4001 \\\\| 30004 \\\\| 30005 \\\\| 30006 | 是 | - | 1000 当前应用appid尚未开通uni一键登录
1001 应用所有者账号信息异常,请检查账号一键登录服务是否正常
1002 应用所有者账号信息异常,请检查账号余额是否充足
1004 uni一键登录应用不存在
4001 参数异常
30004 其他错误
30005 预登录失败
30006 一键登录失败 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n\n##### login 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n\n\n#### close() @close\n关闭登录页\n\n\n##### close 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n\n\n#### isPreLoginValid() @ispreloginvalid\n预登录是否有效\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| boolean | \n\n##### isPreLoginValid 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n\n","compatibility":"### getUniverifyManager 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n","tutorial":"\n### 参见\n[getUniverifyManager](https://uniapp.dcloud.net.cn/univerify.html#univerifymanager)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.univerify.getUniverifyManager)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-univerify-manager/get-univerify-manager.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"getFacialRecognitionMetaInfo":{"name":"## uni.getFacialRecognitionMetaInfo() @getfacialrecognitionmetainfo","description":"获取阿里云实人认证meta info","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"### getFacialRecognitionMetaInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 3.9 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.facial-recognition-verify.getFacialRecognitionMetaInfo)\n"},"startFacialRecognitionVerify":{"name":"## uni.startFacialRecognitionVerify(faceStyle) @startfacialrecognitionverify","description":"启动人脸识别","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| faceStyle | [StartFacialRecognitionVerifyOptions](#startfacialrecognitionverifyoptions-values) | 是 | - | - |\n#### StartFacialRecognitionVerifyOptions 的属性值 @startfacialrecognitionverifyoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| certifyId | string | 是 | - | certifyId 调用实人认证的id |\n| progressBarColor | string | 否 | - | 活体检测页面的进度条颜色。 |\n| screenOrientation | \"land\" \\\\| \"port\" | 否 | \"port\" | 认证界面UI朝向。 |\n| success | (res: [StartFacialRecognitionVerifySuccess](#startfacialrecognitionverifysuccess-values)) => void | 否 | - | 成功回调 |\n| fail | (res: [IFacialRecognitionVerifyError](#ifacialrecognitionverifyerror-values)) => void | 否 | - | 失败回调 |\n| complete | (res: any) => void | 否 | - | 完成回调 |\n\n##### StartFacialRecognitionVerifySuccess 的属性值 @startfacialrecognitionverifysuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | 错误码 |\n| errSubject | string | 是 | - | 调用API的名称 |\n| errMsg | string | 是 | - | 错误的详细信息 |\n| cause | [SourceError](#sourceerror-values) | 否 | - | 错误来源 |\n\n###### SourceError 的属性值 @sourceerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| subject | string | 否 | - | 源错误模块名称 |\n| message | string | 是 | - | 源错误描述信息 |\n| code | number | 是 | - | 源错误的错误码 |\n| name | string | 是 | - | - |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | - |\n\n##### IFacialRecognitionVerifyError 的属性值 @ifacialrecognitionverifyerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 10010 \\\\| 10012 \\\\| 10011 \\\\| 10013 \\\\| 10020 \\\\| 10001 \\\\| 10002 | 是 | - | 错误码
- 10001 certifyId 不能为空
- 10002 \"当前设备不支持\"
- 10010 刷脸异常
- 10012 网络异常
- 10011 验证中断
- 10013 刷脸验证失败
- 10020 设备设置时间异常 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n##### StartFacialRecognitionVerifyOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| screenOrientation | 3.9 | x | - |\n","returnValue":"","compatibility":"### startFacialRecognitionVerify 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 3.9 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.facial-recognition-verify.startFacialRecognitionVerify)\n"},"facial-recognition-verify":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/facial-recognition-verify/facial-recognition-verify.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"createRewardedVideoAd":{"name":"## uni.createRewardedVideoAd(option) @createrewardedvideoad","description":"创建激励视频广告对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [CreateRewardedVideoAdOptions](#createrewardedvideoadoptions-values) | 是 | - | - |\n#### CreateRewardedVideoAdOptions 的属性值 @createrewardedvideoadoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| adpid | string | 是 | - | 广告位 id |\n| urlCallback | [UrlCallbackOptions](#urlcallbackoptions-values) | 否 | - | 服务器回调透传参数 |\n\n##### UrlCallbackOptions 的属性值 @urlcallbackoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| userId | string | 否 | - | 透传到服务器端的userId |\n| extra | string | 否 | - | 透传到服务器端的extra,不推荐设置过于复杂的字符串 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RewardedVideoAd](#rewardedvideoad-values) | \n\n#### RewardedVideoAd 的方法 @rewardedvideoad-values \n\n#### show() @show\n\r\n广告加载成功之后,调用此方法展示广告\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise | \n\n\n\n#### load() @load\n\r\n加载广告\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise | \n\n\n\n#### destroy() @destroy\n\r\n销毁广告\n\n\n\n\n#### onLoad(callback) @onload\n\r\n绑定广告 load 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n\n\n\n#### offLoad(callback) @offload\n\r\n解除绑定 load 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n\n\n\n#### onError(callback) @onerror\n\r\n绑定 error 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | - | - |\n###### IUniAdError 的属性值 @iuniaderror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | 错误码 - -5001 广告位标识adpid为空,请传入有效的adpid - -5002 无效的广告位标识adpid,请使用正确的adpid - -5003 广告位未开通广告,请在广告平台申请并确保已审核通过 - -5004 无广告模块,打包时请配置要使用的广告模块 - -5005 广告加载失败,请稍后重试 - -5006 广告已经展示过了,请重新加载 - -5007 广告不可用或已过期,请重新请求 - -5008 广告不可用或已过期,请重新请求 - -5009 广告类型不符,请检查后再试 - -5011 打包或开通的渠道,不支持此类型广告 - -5013 广告播放失败,请重新加载 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any | 否 | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |\n| errMsg | string | 是 | - | - |\n\n\n\n\n#### offError(callback) @offerror\n\r\n解除绑定 error 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | - | - |\n\n\n\n#### onClose(callback) @onclose\n\r\n绑定 close 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [VideoAdClose](#videoadclose-values)) => void | 是 | - | - |\n###### VideoAdClose 的属性值 @videoadclose-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| isEnded | boolean | 是 | - | true标识广告播放完毕或者达到发放奖励的条件 |\n\n\n\n\n#### offClose(callback) @offclose\n\r\n解除绑定 close 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [VideoAdClose](#videoadclose-values)) => void | 是 | - | - |\n\n\n\n#### onAdClicked(callback) @onadclicked\n\r\n绑定广告可点击屏幕区域事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n\n\n\n#### onVerify(callback) @onverify\n\r\n绑定 verify 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)) => void | 是 | - | - |\n\n\n","compatibility":"### createRewardedVideoAd 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 4.0 | - | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ad.createRewardedVideoAd)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/rewarded-video-ad/rewarded-video-ad.uvue) \n ```vue\n\r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"createWebviewContext":{"name":"## uni.createWebviewContext(webviewId, component?) @createwebviewcontext","description":"创建 web-view 组件的上下文对象,用于操作 web-view 的行为。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| webviewId | string.WebviewIdString | 是 | - | - |\n| component | ComponentPublicInstance | 否 | - | - |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [WebviewContext](#webviewcontext-values) | 否 | \n\n#### WebviewContext 的方法 @webviewcontext-values \n\n#### back() @back\n后退到 web-view 组件网页加载历史的上一页,如果不存在上一页则没有任何效果。\n\n\n##### back 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | - | - |\n\n\n#### forward() @forward\n前进到 web-view 组件网页加载历史的下一页,如果不存在下一页则没有任何效果。\n\n\n##### forward 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | - | - |\n\n\n#### reload() @reload\n重新加载 web-view 组件当前页面。\n\n\n##### reload 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | - | - |\n\n\n#### stop() @stop\n停止加载 web-view 组件当前网页,该方法不能阻止已经加载的 html 文档,但是能够阻止未完成的图片及延迟加载的资源。\n\n\n##### stop 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | - | - |\n\n\n#### evalJS(js) @evaljs\n在网页中执行指定的js脚本,在 uvue 页面中可通过此方法向 web-view 组件加载的页面发送数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| js | string | 是 | - | - |\n\n##### evalJS 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | - | - |\n\n","compatibility":"### createWebviewContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | - | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-webview-context)\n"},"createVideoContext":{"name":"## uni.createVideoContext(videoId, component?) @createvideocontext","description":"创建并返回 video 上下文 videoContext 对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| videoId | string.VideoIdString | 是 | - | - |\n| component | ComponentPublicInstance | 否 | - | - |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [VideoContext](#videocontext-values) | 否 | \n\n#### VideoContext 的方法 @videocontext-values \n\n#### play() @play\n播放\n\n\n##### play 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9.0 | - | 4.0 |\n\n\n#### pause() @pause\n暂停\n\n\n##### pause 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9.0 | - | 4.0 |\n\n\n#### seek(position) @seek\n跳转到指定位置\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| position | number | 是 | - | 跳转到指定位置(秒) |\n\n##### seek 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9.0 | - | 4.0 |\n\n\n#### stop() @stop\n停止视频\n\n\n##### stop 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9.0 | - | 4.0 |\n\n\n#### sendDanmu(danmu) @senddanmu\n发送弹幕\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| danmu | [Danmu](#danmu-values) | 是 | - | text, color |\n###### Danmu 的属性值 @danmu-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| text | string | 否 | - | 弹幕文字 |\n| color | string | 否 | - | 弹幕颜色 |\n| time | number | 否 | - | 显示时刻 |\n\n\n##### sendDanmu 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9.0 | - | 4.0 |\n\n\n#### playbackRate(rate) @playbackrate\n设置倍速播放\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| rate | number | 是 | - | , 支持倍率 0.5/0.8/1.0/1.25/1.5 |\n\n##### playbackRate 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9.0 | - | 4.0 |\n\n\n#### requestFullScreen(direction?) @requestfullscreen\n进入全屏\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| direction | [RequestFullScreenOptions](#requestfullscreenoptions-values) | 否 | - | , 0\\|正常竖向, 90\\|屏幕逆时针90度, -90\\|屏幕顺时针90度 |\n###### RequestFullScreenOptions 的属性值 @requestfullscreenoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| direction | number | 否 | - | direction - 0: 正常竖向 - 90: 屏幕逆时针90度 - -90: 屏幕顺时针90度 |\n\n###### RequestFullScreenOptions 兼容性 \n| | Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- | :- |\n| direction | 4.4 | 3.9.0 | - | x |\n\n\n##### requestFullScreen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9.0 | - | 4.0 |\n\n\n#### exitFullScreen() @exitfullscreen\n退出全屏\n\n\n##### exitFullScreen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9.0 | - | 4.0 |\n\n","compatibility":"### createVideoContext 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | √ | - | 4.0 |\n","tutorial":"\n### 参见\n[createVideoContext](http://uniapp.dcloud.io/api/media/video-context?id=createVideoContext)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-video-context)\n"},"general_type":{"name":"## 通用类型\n","param":"### GeneralCallbackResult \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | 错误信息 |\n"}}
\ No newline at end of file
+{"getApp":{"name":"## getApp() @getapp","description":"\r\n`getApp()` 函数用于获取当前应用实例,可通过应用实例调用 App.uvue methods 中定义的方法。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"","tutorial":"\n### 参见\n[getApp](https://uniapp.dcloud.net.cn/tutorial/page.html#getapp)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.global.get-app)\n"},"get-app":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app/get-app.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-app/get-app\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 初始的 globalData:\r\n globalData string: {{ originGlobalData.str }}\r\n globalData number: {{ originGlobalData.num }}\r\n globalData boolean: {{ originGlobalData.bool }}\r\n globalData object: {{ originGlobalData.obj }}\r\n globalData null: {{ originGlobalData.null }}\r\n globalData array: {{ originGlobalData.arr }}\r\n globalData Set: {{ originGlobalData.mySet }}\r\n globalData Map: {{ originGlobalData.myMap }}\r\n globalData func 返回值: {{ originGlobalDataFuncRes }}\r\n \r\n \r\n \r\n 更新后的 globalData:\r\n globalData string: {{ newGlobalData.str }}\r\n globalData number: {{ newGlobalData.num }}\r\n globalData boolean: {{ newGlobalData.bool }}\r\n globalData object: {{ newGlobalData.obj }}\r\n globalData null: {{ newGlobalData.null }}\r\n globalData array: {{ newGlobalData.arr }}\r\n globalData Set: {{ newGlobalData.mySet }}\r\n globalData Map: {{ newGlobalData.myMap }}\r\n globalData func 返回值: {{ newGlobalDataFuncRes }}\r\n \r\n 点击按钮调用 App.uvue methods\r\n increasetLifeCycleNum 方法\r\n \r\n lifeCycleNum: {{ lifeCycleNum }}\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n type MyGlobalData = {\r\n str : string,\r\n num : number,\r\n bool : boolean,\r\n obj : UTSJSONObject,\r\n null : string | null,\r\n arr : number[],\r\n mySet : string[],\r\n myMap : UTSJSONObject,\r\n func : () => string\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n originGlobalData: {\r\n str: '',\r\n num: 0,\r\n bool: false,\r\n obj: {\r\n str: '',\r\n num: 0,\r\n bool: false\r\n } as UTSJSONObject,\r\n null: null,\r\n arr: [] as number[],\r\n mySet: [] as string[],\r\n myMap: {},\r\n func: () : string => ''\r\n } as MyGlobalData,\r\n originGlobalDataFuncRes: '',\r\n newGlobalData: {\r\n str: '',\r\n num: 0,\r\n bool: false,\r\n obj: {\r\n str: '',\r\n num: 0,\r\n bool: false\r\n } as UTSJSONObject,\r\n null: null,\r\n arr: [] as number[],\r\n mySet: [] as string[],\r\n myMap: {},\r\n func: () : string => ''\r\n } as MyGlobalData,\r\n newGlobalDataFuncRes: '',\r\n lifeCycleNum: 0,\r\n }\r\n },\r\n onReady() {\r\n this.lifeCycleNum = state.lifeCycleNum\r\n },\r\n methods: {\r\n getGlobalData() {\r\n const app = getApp()\r\n\r\n this.originGlobalData.str = app.globalData.str\r\n this.originGlobalData.num = app.globalData.num\r\n this.originGlobalData.bool = app.globalData.bool\r\n this.originGlobalData.obj = app.globalData.obj\r\n this.originGlobalData.null = app.globalData.null\r\n this.originGlobalData.arr = app.globalData.arr\r\n app.globalData.mySet.forEach((value : string) => {\r\n this.originGlobalData.mySet.push(value)\r\n })\r\n app.globalData.myMap.forEach((value : any, key : string) => {\r\n this.originGlobalData.myMap[key] = value\r\n })\r\n this.originGlobalData.func = app.globalData.func\r\n this.originGlobalDataFuncRes = this.originGlobalData.func()\r\n },\r\n setGlobalData() {\r\n const app = getApp()\r\n\r\n app.globalData.str = 'new globalData str'\r\n app.globalData.num = 100\r\n app.globalData.bool = true\r\n app.globalData.obj = {\r\n str: 'new globalData obj str',\r\n num: 200,\r\n bool: true\r\n }\r\n app.globalData.null = 'not null'\r\n app.globalData.arr = [1, 2, 3]\r\n app.globalData.mySet = new Set(['a', 'b', 'c'])\r\n app.globalData.myMap = new Map([\r\n ['a', 1],\r\n ['b', 2],\r\n ['c', 3]\r\n ])\r\n app.globalData.func = () : string => {\r\n return 'new globalData func'\r\n }\r\n\r\n this.newGlobalData.str = app.globalData.str\r\n this.newGlobalData.num = app.globalData.num\r\n this.newGlobalData.bool = app.globalData.bool\r\n this.newGlobalData.obj = app.globalData.obj\r\n this.newGlobalData.null = app.globalData.null\r\n this.newGlobalData.arr = app.globalData.arr\r\n app.globalData.mySet.forEach((value : string) => {\r\n this.newGlobalData.mySet.push(value)\r\n })\r\n app.globalData.myMap.forEach((value : any, key : string) => {\r\n this.newGlobalData.myMap[key] = value\r\n })\r\n this.newGlobalData.func = app.globalData.func\r\n this.newGlobalDataFuncRes = this.newGlobalData.func()\r\n },\r\n _increasetLifeCycleNum: function () {\r\n const app = getApp()\r\n app.increasetLifeCycleNum()\r\n this.lifeCycleNum = state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n }\r\n },\r\n }\r\n\n```\n\n:::"},"getCurrentPages":{"name":"## getCurrentPages() @getcurrentpages","description":"\r\n`getCurrentPages()` 函数用于获取当前页面栈的实例,以数组形式按栈的顺序给出,数组中的元素为页面实例,第一个元素为首页,最后一个元素为当前页面。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[Page](#page-values)\\> | \n\n#### Page 的属性值 @page-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| route | string | 是 | - | 页面的路由地址 |\n| options | Map\\ | 是 | - | 页面的路由参数信息 |\n","compatibility":"","tutorial":"\n### 参见\n[getCurrentPages](https://uniapp.dcloud.net.cn/tutorial/page.html#getcurrentpages)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.global.get-current-pages)\n"},"get-current-pages":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-current-pages/get-current-pages.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-current-pages/get-current-pages\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n 当前页面栈中 {{ pages.length }} 个页面,列表如下:\r\n \r\n index: {{ index }}, route: {{ page.route }}\r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n class Page {\r\n constructor(public route : string) {\r\n }\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n checked: false,\r\n pages: [] as Page[],\r\n }\r\n },\r\n methods: {\r\n _getCurrentPages: function () {\r\n this.pages.length = 0\r\n const pages = getCurrentPages()\r\n this.pages.push(new Page(pages[0].route))\r\n if (this.pages[0].route.includes('/tabBar/')) {\r\n this.checked = true\r\n }\r\n for (let i = 1; i < pages.length; i++) {\r\n this.pages.push(new Page(pages[i].route))\r\n if (pages[i].route.includes('/tabBar/')) {\r\n this.checked = false\r\n }\r\n }\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"$on":{"name":"## uni.$on(eventName, callback) @$on","description":"\r\n监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| eventName | string | 是 | - | - |\n| callback | () => void | 是 | - | - |","returnValue":"","compatibility":"### $on 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[$on](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#on)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$on)\n"},"$once":{"name":"## uni.$once(eventName, callback) @$once","description":"\r\n监听一个自定义事件。事件只触发一次,在第一次触发之后移除事件监听器。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| eventName | string | 是 | - | - |\n| callback | () => void | 是 | - | - |","returnValue":"","compatibility":"### $once 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[$once](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#once)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$once)\n"},"$off":{"name":"## uni.$off(eventName, callback) @$off","description":"\r\n移除自定义事件监听器。如果没有指定事件名,则移除所有事件监听器。如果提供事件名,则移除该事件的所有监听器。如果提供了事件名和回调,则只移除这个回调的监听器。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| eventName | string | 是 | - | - |\n| callback | () => void | 是 | - | - |","returnValue":"","compatibility":"### $off 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[$off](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#off)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$off)\n"},"$emit":{"name":"## uni.$emit(eventName, args?) @$emit","description":"\r\n触发自定义事件,附加的参数会传递给事件监听器。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| eventName | string | 是 | - | - |\n| args | any \\| null | 否 | - | |","returnValue":"","compatibility":"### $emit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[$emit](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$emit)\n"},"event-bus":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/event-bus/event-bus.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/event-bus/event-bus\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 收到的消息:\r\n \r\n {{ item }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n log: [] as string[],\r\n }\r\n },\r\n methods: {\r\n fn(res : string) {\r\n this.log.push(res)\r\n },\r\n on() {\r\n uni.$on('test', this.fn)\r\n },\r\n once() {\r\n uni.$once('test', this.fn)\r\n },\r\n off() {\r\n uni.$off('test', this.fn)\r\n },\r\n emit() {\r\n uni.$emit('test', 'msg:' + Date.now())\r\n },\r\n clear() {\r\n this.log.length = 0\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"addInterceptor":{"name":"## uni.addInterceptor(name, interceptor) @addinterceptor","description":"\r\n添加拦截器","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | 需要拦截的 API 名称 |\n| interceptor | [Interceptor](#interceptor-values) | 是 | - | 拦截器 |\n#### Interceptor 的属性值 @interceptor-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| invoke | Function \\| null | 否 | - | |\n| returnValue | Function \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n","returnValue":"","compatibility":"### addInterceptor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | x | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.interceptor.addInterceptor)\n"},"removeInterceptor":{"name":"## uni.removeInterceptor(name, interceptor?) @removeinterceptor","description":"\r\n删除拦截器","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | 需要删除拦截器的 API 名称 |\n| interceptor | interface \\| null | 否 | - | |","returnValue":"","compatibility":"### removeInterceptor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | x | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.interceptor.removeInterceptor)\n"},"interceptor":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/interceptor/interceptor.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/interceptor/interceptor\n>Template\n```vue\n\r\n \r\n \r\n \r\n 点击下方按钮{{msg}}\r\n \r\n \r\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n const interceptor = {\r\n invoke: function (options : NavigateToOptions) {\r\n console.log('拦截 navigateTo 接口传入参数为:', options)\r\n const url = './page2'\r\n uni.showToast({\r\n title: `重定向到页面:${url}`\r\n })\r\n options.url = url\r\n },\r\n success: function (res : NavigateBackSuccess) {\r\n console.log('拦截 navigateTo 接口 success 返回参数为:', res)\r\n },\r\n fail: function (err : NavigateToFail) {\r\n console.log('拦截 navigateTo 接口 fail 返回参数为:', err)\r\n },\r\n complete: function (res : NavigateToComplete) {\r\n console.log('拦截 navigateTo 接口 complete 返回参数为:', res)\r\n }\r\n } as Interceptor\r\n export default {\r\n data() {\r\n return {\r\n msg: \"会跳转到测试页面1\"\r\n }\r\n },\r\n beforeUnmount() {\r\n // 移除 navigateTo 所有拦截器\r\n uni.removeInterceptor('navigateTo')\r\n },\r\n methods: {\r\n addInterceptor() {\r\n uni.addInterceptor('navigateTo', interceptor)\r\n uni.showToast({\r\n title: '页面跳转已拦截'\r\n })\r\n this.msg = \",路由被劫持到测试页面2\"\r\n },\r\n removeInterceptor() {\r\n uni.removeInterceptor('navigateTo', interceptor)\r\n uni.showToast({\r\n title: '拦截器已移除'\r\n })\r\n this.msg = \"会跳转到测试页面1\"\r\n },\r\n navigateTo() {\r\n uni.navigateTo({\r\n url: './page1',\r\n success(res) {\r\n console.log('res:', res)\r\n },\r\n fail(err) {\r\n console.error('err:', err)\r\n },\r\n complete(res) {\r\n console.log('res:', res)\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"getLaunchOptionsSync":{"name":"## uni.getLaunchOptionsSync() @getlaunchoptionssync","description":"\r\n获取本次启动时的参数。返回值与App.onLaunch的回调参数一致\r\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [OnLaunchOptions](#onlaunchoptions-values) | \n\n#### OnLaunchOptions 的属性值 @onlaunchoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string | 是 | - | - |\n","compatibility":"### getLaunchOptionsSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[getLaunchOptionsSync](https://doc.dcloud.net.cn/uni-app-x/api/get-launch-options-sync.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.get-launch-options-sync)\n"},"get-launch-options-sync":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-launch-options-sync/get-launch-options-sync.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-launch-options-sync/get-launch-options-sync\n>Template\n```vue\n\r\n \r\n \r\n \r\n 0\" class=\"uni-common-mt\">\r\n 应用启动路径:\r\n {{ launchOptionsPath }}\r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\nexport default {\r\n data() {\r\n return {\r\n checked: false,\r\n homePagePath: 'pages/tabBar/component',\r\n launchOptionsPath: '',\r\n }\r\n },\r\n methods: {\r\n getLaunchOptionsSync() {\r\n const launchOptions = uni.getLaunchOptionsSync()\r\n this.launchOptionsPath = launchOptions.path\r\n\r\n if (launchOptions.path == this.homePagePath) {\r\n this.checked = true\r\n }\r\n },\r\n },\r\n}\r\n\n```\n\n:::"},"exit":{"name":"## uni.exit(options?) @exit","description":"\r\n退出当前应用","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | interface \\| null | 否 | - | uni.exit参数定义 |","returnValue":"","compatibility":"### exit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | x | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.exit)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/exit/exit.uvue) \n ```vue\n\r\n\t\r\n\t\t\r\n\t\r\n\r\n\r\n\r\n\r\n\n```"},"env":{"name":"## env","description":"","param":"### env 的属性值 @env-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| USER_DATA_PATH | string | 是 | - | 应用专属存储空间的外置存储空间根目录下的files目录 |\n| CACHE_PATH | string | 是 | - | 应用专属存储空间的外置存储空间根目录下的cache目录 |\n| SANDBOX_PATH | string | 是 | - | 应用专属存储空间的外置存储空间根目录(caches/files) |\n","compatibility":"#### env 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| USER_DATA_PATH | 3.99 | x | - |\n| CACHE_PATH | 3.99 | x | - |\n| SANDBOX_PATH | 3.99 | x | - |\n","returnValue":"","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.env)\n"},"navigateTo":{"name":"## uni.navigateTo(options) @navigateto","description":"\r\n保留当前页面,跳转到应用内的某个页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [NavigateToOptions](#navigatetooptions-values) | 是 | - | - |\n#### NavigateToOptions 的属性值 @navigatetooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string (string.PageURIString) | 是 | - | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| animationType | string \\| null | 否 | - | |\n| animationDuration | number \\| null | 否 | - | |\n| events | any \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n##### NavigateToOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| url | √ | x | 4.0 |\n| animationType | x | x | 4.0 |\n| animationDuration | x | x | 4.0 |\n| events | x | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### navigateTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[navigateTo](http://uniapp.dcloud.io/api/router?id=navigateto)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.navigateTo)\n"},"reLaunch":{"name":"## uni.reLaunch(options) @relaunch","description":"\r\n关闭所有页面,打开到应用内的某个页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ReLaunchOptions](#relaunchoptions-values) | 是 | - | - |\n#### ReLaunchOptions 的属性值 @relaunchoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string (string.PageURIString) | 是 | - | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n##### ReLaunchOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| url | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### reLaunch 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[reLaunch](http://uniapp.dcloud.io/api/router?id=relaunch)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.reLaunch)\n"},"navigateBack":{"name":"## uni.navigateBack(options?) @navigateback","description":"\r\n关闭当前页面,返回上一页面或多级页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | interface \\| null | 否 | - | |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### navigateBack 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[navigateBack](http://uniapp.dcloud.io/api/router?id=navigateback)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.navigateBack)\n"},"redirectTo":{"name":"## uni.redirectTo(options) @redirectto","description":"\r\n关闭当前页面,跳转到应用内的某个页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RedirectToOptions](#redirecttooptions-values) | 是 | - | - |\n#### RedirectToOptions 的属性值 @redirecttooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string (string.PageURIString) | 是 | - | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n##### RedirectToOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| url | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### redirectTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[redirectTo](http://uniapp.dcloud.io/api/router?id=redirectto)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.redirectTo)\n"},"switchTab":{"name":"## uni.switchTab(options) @switchtab","description":"\r\n跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SwitchTabOptions](#switchtaboptions-values) | 是 | - | - |\n#### SwitchTabOptions 的属性值 @switchtaboptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string (string.PageURIString) | 是 | - | 需要跳转的 tabBar 页面的路径,路径后不能带参数 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n##### SwitchTabOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| url | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### switchTab 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[switchTab](http://uniapp.dcloud.io/api/router?id=switchtab)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.switchTab)\n"},"navigator":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/navigator/navigator.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/navigator/navigator\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n onLoad触发时间戳:\r\n {{ onLoadTime }}\r\n \r\n \r\n onShow触发时间戳:\r\n {{ onShowTime }}\r\n \r\n \r\n onReady触发时间戳:\r\n {{ onReadyTime }}\r\n \r\n \r\n onHide触发时间戳:\r\n {{ onHideTime }}\r\n \r\n \r\n onBackPress触发时间戳:\r\n 见控制台\r\n \r\n \r\n onUnload触发时间戳:\r\n 见控制台\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n data() {\r\n return {\r\n onLoadTime: 0,\r\n onShowTime: 0,\r\n onReadyTime: 0,\r\n onHideTime: 0,\r\n }\r\n },\r\n onLoad() {\r\n this.onLoadTime = Date.now()\r\n console.log('onLoad', this.onLoadTime)\r\n },\r\n onShow() {\r\n this.onShowTime = Date.now()\r\n console.log('onShow', this.onShowTime)\r\n },\r\n onReady() {\r\n this.onReadyTime = Date.now()\r\n console.log('onReady', this.onReadyTime)\r\n },\r\n onHide() {\r\n this.onHideTime = Date.now()\r\n console.log('onHide', this.onHideTime)\r\n },\r\n onBackPress(options : OnBackPressOptions) : boolean | null {\r\n console.log('onBackPress', Date.now())\r\n console.log('onBackPress from', options.from)\r\n return null\r\n },\r\n onUnload() {\r\n console.log('onUnload', Date.now())\r\n },\r\n methods: {\r\n reLaunch() {\r\n uni.reLaunch({\r\n url: '/pages/tabBar/component',\r\n success(result) {\r\n console.log('reLaunch success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('reLaunch fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('reLaunch complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateTo() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=Hello',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateToErrorPage() {\r\n uni.navigateTo({\r\n url: '/pages/error-page/error-page',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n uni.showToast({\r\n title: error.errMsg,\r\n icon: 'none',\r\n })\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateToDebounce() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=debounce',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=debounce',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath1() {\r\n uni.navigateTo({\r\n url: 'new-page/new-page-1?data=new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath2() {\r\n uni.navigateTo({\r\n url: './new-page/new-page-1?data=./new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath3() {\r\n uni.navigateTo({\r\n url: '../navigator/new-page/new-page-1?data=../navigator/new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateBack() {\r\n uni.navigateBack({\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateBackWithDelta1() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1',\r\n success() {\r\n uni.navigateBack({\r\n delta: 1,\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n })\r\n },\r\n navigateBackWithDelta100() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1',\r\n success() {\r\n uni.navigateBack({\r\n delta: 100,\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n })\r\n },\r\n redirectTo() {\r\n uni.redirectTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=Hello',\r\n success(result) {\r\n console.log('redirectTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('redirectTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('redirectTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n switchTab() {\r\n uni.switchTab({\r\n url: '/pages/tabBar/template',\r\n success(result) {\r\n console.log('switchTab success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('switchTab fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('switchTab complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"setNavigationBarColor":{"name":"## uni.setNavigationBarColor(options) @setnavigationbarcolor","description":"\r\n设置导航条、状态栏颜色\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetNavigationBarColorOptions](#setnavigationbarcoloroptions-values) | 是 | - | - |\n#### SetNavigationBarColorOptions 的属性值 @setnavigationbarcoloroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| frontColor | \"#ffffff\" \\| \"#000000\" | 是 | - | 前景颜色值,包括按钮、标题、状态栏的颜色,仅支持 #ffffff 和 #000000 |\n| backgroundColor | string | 是 | - | 背景颜色值,有效值为十六进制颜色 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (error: [SetNavigationBarColorError](#setnavigationbarcolorerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetNavigationBarColorError 的属性值 @setnavigationbarcolorerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetNavigationBarColorOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| frontColor | √ | x | 4.0 |\n| backgroundColor | √ | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### setNavigationBarColor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[setNavigationBarColor](https://doc.dcloud.net.cn/uni-app-x/api/set-navigation-bar-color.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-navigation-bar-color)\n"},"set-navigation-bar-color":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/set-navigation-bar-color/set-navigation-bar-color.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/set-navigation-bar-color/set-navigation-bar-color\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n methods: {\r\n setNavigationBarColor1() {\r\n uni.setNavigationBarColor({\r\n frontColor: '#ffffff',\r\n backgroundColor: '#00ff00',\r\n success: () => {\r\n console.log('setNavigationBarColor success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarColor fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarColor complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n setNavigationBarColor2() {\r\n uni.setNavigationBarColor({\r\n frontColor: '#000000',\r\n backgroundColor: '#ff0000',\r\n success: () => {\r\n console.log('setNavigationBarColor success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarColor fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarColor complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n },\r\n goCustomNavigation() {\r\n uni.navigateTo({\r\n url: '/pages/template/navbar-lite/navbar-lite'\r\n })\r\n }\r\n },\r\n }\r\n\n```\n\n:::"},"setNavigationBarTitle":{"name":"## uni.setNavigationBarTitle(options) @setnavigationbartitle","description":"\r\n动态设置当前页面的标题\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetNavigationBarTitleOptions](#setnavigationbartitleoptions-values) | 是 | - | - |\n#### SetNavigationBarTitleOptions 的属性值 @setnavigationbartitleoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 是 | - | 页面标题 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (error: [SetNavigationBarTitleError](#setnavigationbartitleerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetNavigationBarTitleError 的属性值 @setnavigationbartitleerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| errMsg | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetNavigationBarTitleOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| title | 3.97 | x | 4.0 |\n| success | 3.97 | x | 4.0 |\n| fail | 3.97 | x | 4.0 |\n| complete | 3.97 | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### setNavigationBarTitle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | x | 4.0 |\n","tutorial":"\n### 参见\n[setNavigationBarTitle](https://doc.dcloud.net.cn/uni-app-x/api/set-navigation-bar-title.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-navigation-bar-title)\n"},"set-navigation-bar-title":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/set-navigation-bar-title/set-navigation-bar-title.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/set-navigation-bar-title/set-navigation-bar-title\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n data() {\r\n return {\r\n newTitle: 'new title',\r\n longTitle: 'long title long title long title long title long title long title long title long title long title long title'\r\n }\r\n },\r\n methods: {\r\n setNavigationBarNewTitle() {\r\n uni.setNavigationBarTitle({\r\n title: this.newTitle,\r\n success: () => {\r\n console.log('setNavigationBarTitle success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarTitle fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarTitle complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n setNavigationBarLongTitle() {\r\n uni.setNavigationBarTitle({\r\n title: this.longTitle,\r\n success() {\r\n console.log('setNavigationBarTitle success')\r\n },\r\n fail() {\r\n console.log('setNavigationBarTitle fail')\r\n },\r\n complete() {\r\n console.log('setNavigationBarTitle complete')\r\n }\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n }\r\n },\r\n }\r\n\n```\n\n:::"},"showTabBar":{"name":"## uni.showTabBar(options?) @showtabbar","description":"\r\n显示 tabBar\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | interface \\| null | 否 | - | |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### showTabBar 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[showTabBar](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#showtabbar)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.showTabBar)\n"},"hideTabBar":{"name":"## uni.hideTabBar(options?) @hidetabbar","description":"\r\n隐藏 tabBar\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | interface \\| null | 否 | - | |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### hideTabBar 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[hideTabBar](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#hidetabbar)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.hideTabBar)\n"},"showTabBarRedDot":{"name":"## uni.showTabBarRedDot(options) @showtabbarreddot","description":"\r\n显示 tabBar 某一项的右上角的红点\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowTabBarRedDotOptions](#showtabbarreddotoptions-values) | 是 | - | - |\n#### ShowTabBarRedDotOptions 的属性值 @showtabbarreddotoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar的哪一项,从左边算起,索引从0开始 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### showTabBarRedDot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[showTabBarRedDot](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#showtabbarreddot)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.showTabBarRedDot)\n"},"hideTabBarRedDot":{"name":"## uni.hideTabBarRedDot(options) @hidetabbarreddot","description":"\r\n隐藏 tabBar 某一项的右上角的红点\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [HideTabBarRedDotOptions](#hidetabbarreddotoptions-values) | 是 | - | - |\n#### HideTabBarRedDotOptions 的属性值 @hidetabbarreddotoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar的哪一项,从左边算起,索引从0开始 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### hideTabBarRedDot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[hideTabBarRedDot](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#hidetabbarreddot)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.hideTabBarRedDot)\n"},"setTabBarBadge":{"name":"## uni.setTabBarBadge(options) @settabbarbadge","description":"\r\n为 tabBar 某一项的右上角添加文本\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetTabBarBadgeOptions](#settabbarbadgeoptions-values) | 是 | - | - |\n#### SetTabBarBadgeOptions 的属性值 @settabbarbadgeoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar的哪一项,从左边算起,索引从0开始 |\n| text | string | 是 | - | 显示的文本,不超过 3 个半角字符 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### setTabBarBadge 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[setTabBarBadge](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbarbadge)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarBadge)\n"},"removeTabBarBadge":{"name":"## uni.removeTabBarBadge(options) @removetabbarbadge","description":"\r\n移除 tabBar 某一项右上角的文本\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RemoveTabBarBadgeOptions](#removetabbarbadgeoptions-values) | 是 | - | - |\n#### RemoveTabBarBadgeOptions 的属性值 @removetabbarbadgeoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar的哪一项,从左边算起,索引从0开始 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### removeTabBarBadge 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[removeTabBarBadge](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#removetabbarbadge)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.removeTabBarBadge)\n"},"setTabBarStyle":{"name":"## uni.setTabBarStyle(options) @settabbarstyle","description":"\r\n动态设置 tabBar 的整体样式\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetTabBarStyleOptions](#settabbarstyleoptions-values) | 是 | - | - |\n#### SetTabBarStyleOptions 的属性值 @settabbarstyleoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| color | string (string.ColorString) | 否 | - | tab 上的文字默认颜色 |\n| selectedColor | string (string.ColorString) | 否 | - | tab 上的文字选中时的颜色 |\n| backgroundColor | string (string.ColorString) | 否 | - | tab 的背景色 |\n| backgroundImage | string | 否 | - | 图片背景 |\n| backgroundRepeat | \"repeat\" \\| \"repeat-x\" \\| \"repeat-y\" \\| \"no-repeat\" | 否 | - | 背景图平铺方式
- repeat: 背景图片在垂直方向和水平方向平铺
- repeat-x: 背景图片在水平方向平铺,垂直方向拉伸
- repeat-y: 背景图片在垂直方向平铺,水平方向拉伸
- no-repeat: 背景图片在垂直方向和水平方向都拉伸 |\n| borderStyle | string | 否 | - | tabbar上边框的颜色 |\n| midButton | [MidButtonOptions](#midbuttonoptions-values) | 否 | - | tabbar 中间按钮 仅在 list 项为偶数时有效 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### MidButtonOptions 的属性值 @midbuttonoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| width | string | 否 | - | 中间按钮的宽度,tabBar 其它项为减去此宽度后平分,默认值为与其它项平分宽度。默认 80px |\n| height | string | 否 | - | 中间按钮的高度,可以大于 tabBar 高度,达到中间凸起的效果。默认 50px |\n| text | string | 否 | - | 中间按钮的文字 |\n| iconPath | string | 否 | - | 中间按钮的图片路径 |\n| iconWidth | string | 否 | - | 图片宽度(高度等比例缩放)。默认 24px |\n| backgroundImage | string | 否 | - | 中间按钮的背景图片路径 |\n| iconfont | [MidButtonIconFont](#midbuttoniconfont-values) | 否 | - | 字体图标,优先级高于 iconPath |\n\n###### MidButtonIconFont 的属性值 @midbuttoniconfont-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| text | string | 否 | - | 字库 Unicode 码 |\n| selectedText | string | 否 | - | 选中后字库 Unicode 码 |\n| fontSize | string | 否 | - | 字体图标字号(px) |\n| color | string | 否 | - | 字体图标颜色 |\n| selectedColor | string | 否 | - | 字体图标选中颜色 |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### setTabBarStyle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[setTabBarStyle](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbarstyle)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarStyle)\n"},"setTabBarItem":{"name":"## uni.setTabBarItem(options) @settabbaritem","description":"\r\n动态设置 tabBar 某一项的内容\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetTabBarItemOptions](#settabbaritemoptions-values) | 是 | - | - |\n#### SetTabBarItemOptions 的属性值 @settabbaritemoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | tabBar 的哪一项,从左边算起,索引从0开始 |\n| text | string | 否 | - | tab 上按钮文字 |\n| iconPath | string | 否 | - | 图片路径 |\n| selectedIconPath | string | 否 | - | 选中时的图片路径 |\n| pagePath | string | 否 | - | 页面绝对路径 |\n| iconfont | [SetTabBarItemIconFontOptions](#settabbaritemiconfontoptions-values) | 否 | - | 字体图标,优先级高于 iconPath |\n| visible | boolean | 否 | - | tab 是否显示 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (result: [SetTabBarError](#settabbarerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### SetTabBarItemIconFontOptions 的属性值 @settabbaritemiconfontoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| text | string | 是 | - | 字库 Unicode 码 |\n| selectedText | string | 是 | - | 选中后字库 Unicode 码 |\n| fontSize | string | 否 | - | 字体图标字号(px) |\n| color | string | 否 | - | 字体图标颜色 |\n| selectedColor | string | 否 | - | 字体图标选中颜色 |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### SetTabBarError 的属性值 @settabbarerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 100 \\| 200 | 是 | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### setTabBarItem 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[setTabBarItem](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbaritem)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarItem)\n"},"startPullDownRefresh":{"name":"## uni.startPullDownRefresh(options?) @startpulldownrefresh","description":"\r\n开始下拉刷新\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | interface \\| null | 否 | - | |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### startPullDownRefresh 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[startPullDownRefresh](https://uniapp.dcloud.io/uni-app-x/api/pull-down-refresh.html#startpulldownrefresh)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.pull-down-refresh.startPullDownRefresh)\n"},"stopPullDownRefresh":{"name":"## uni.stopPullDownRefresh() @stoppulldownrefresh","description":"\r\n停止当前页面下拉刷新\r\n","param":"","returnValue":"","compatibility":"### stopPullDownRefresh 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[stopPullDownRefresh](https://doc.dcloud.net.cn/uni-app-x/api/pull-down-refresh.html#stoppulldownrefresh)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.pull-down-refresh.stopPullDownRefresh)\n"},"pull-down-refresh":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/pull-down-refresh/pull-down-refresh.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/pull-down-refresh/pull-down-refresh\n>Template\n```vue\n\r\n\t\r\n\t\t\r\n\t\t\r\n\t\t\tlist - {{num}}\r\n\t\t\t{{loadMoreText}}\r\n\t\t\r\n\t\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n\texport default {\r\n\t\tdata() {\r\n\t\t\treturn {\r\n\t\t\t\tdata: [] as Array,\r\n\t\t\t\tloadMoreText: \"加载中...\",\r\n\t\t\t\tshowLoadMore: false,\r\n\t\t\t\tmax: 0\r\n\t\t\t}\r\n\t\t},\r\n\t\tonLoad() {\r\n\t\t\tthis.initData();\r\n\t\t},\r\n\t\tonReachBottom() {\r\n\t\t\tconsole.log(\"onReachBottom\");\r\n\t\t\tif (this.max > 40) {\r\n\t\t\t\tthis.loadMoreText = \"没有更多数据了!\"\r\n\t\t\t\treturn;\r\n\t\t\t}\r\n\t\t\tthis.showLoadMore = true;\r\n\t\t\tsetTimeout(() => {\r\n\t\t\t\tthis.setListData();\r\n\t\t\t}, 300);\r\n\t\t},\r\n\t\tonPullDownRefresh() {\r\n\t\t\tconsole.log('onPullDownRefresh');\r\n\t\t\tthis.initData();\r\n\t\t},\r\n\t\tmethods: {\r\n\t\t\tinitData(){\r\n\t\t\t\tsetTimeout(() => {\r\n\t\t\t\t\tthis.max = 0;\r\n\t\t\t\t\tthis.data = [];\r\n\t\t\t\t\tlet data:Array = [];\r\n\t\t\t\t\tthis.max += 20;\r\n\t\t\t\t\tfor (let i:number = this.max - 19; i < this.max + 1; i++) {\r\n\t\t\t\t\t\tdata.push(i)\r\n\t\t\t\t\t}\r\n\t\t\t\t\tthis.data = this.data.concat(data);\r\n\t\t\t\t\tuni.stopPullDownRefresh();\r\n\t\t\t\t}, 300);\r\n\t\t\t},\r\n\t\t\tsetListData() {\r\n\t\t\t\tlet data:Array = [];\r\n\t\t\t\tthis.max += 10;\r\n\t\t\t\tfor (let i:number = this.max - 9; i < this.max + 1; i++) {\r\n\t\t\t\t\tdata.push(i)\r\n\t\t\t\t}\r\n\t\t\t\tthis.data = this.data.concat(data);\r\n\t\t\t}\r\n\t\t}\r\n\t}\r\n\n```\n\n:::"},"pageScrollTo":{"name":"## uni.pageScrollTo(options) @pagescrollto","description":"\r\n将页面滚动到目标位置\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [PageScrollToOptions](#pagescrolltooptions-values) | 是 | - | - |\n#### PageScrollToOptions 的属性值 @pagescrolltooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| scrollTop | number \\| null | 否 | - | |\n| selector | string \\| null | 否 | - | |\n| offsetTop | number \\| null | 否 | - | |\n| duration | number \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n##### PageScrollToOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| offsetTop | 3.91 | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### pageScrollTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[pageScrollTo](https://doc.dcloud.net.cn/uni-app-x/api/page-scroll-to.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.page-scroll-to)\n"},"page-scroll-to":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/page-scroll-to/page-scroll-to.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/page-scroll-to/page-scroll-to\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{ index }}\r\n \r\n scrollTo-custom-element\r\n \r\n {{ index2 }}\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'pageScrollTo',\r\n }\r\n },\r\n methods: {\r\n scrollTo() {\r\n uni.pageScrollTo({\r\n scrollTop: 100,\r\n duration: 300,\r\n success: () => {\r\n console.log('success')\r\n },\r\n })\r\n },\r\n scrollToElement() {\r\n uni.pageScrollTo({\r\n selector: '.custom-element',\r\n duration: 300,\r\n success: () => {\r\n console.log('success')\r\n },\r\n })\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"getElementById":{"name":"## uni.getElementById(id) @getelementbyid","description":"\r\n返回一个匹配特定 ID 的元素, 如果不存在,返回 null。\\\r\n如果需要获取指定的节点类型,需要使用 as 进行类型转换。\\\r\nID 区分大小写,且应该是唯一的。如果存在多个匹配的元素,则返回第一个匹配的元素。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| id | string.IDString \\| string | 是 | - | - |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| interface \\| null | 否 | \n","compatibility":"### getElementById 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[getElementById](https://doc.dcloud.net.cn/uni-app-x/api/get-element.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.dom.get-element.getElementById)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-element-by-id/get-element-by-id.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-element-by-id/get-element-by-id\n>Template\n```vue\n\r\n \r\n \r\n this is text\r\n this is view\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n checked: false,\r\n homePagePath: '/pages/tabBar/component',\r\n launchOptionsPath: '',\r\n }\r\n },\r\n methods: {\r\n getElementByNotExistId() : Element | null {\r\n return uni.getElementById('not-exist-id')\r\n },\r\n changePageHeadBackgroundColor() {\r\n const pageHead = uni.getElementById('page-head')!\r\n pageHead.style.setProperty('background-color', 'red')\r\n },\r\n changeTextColor() {\r\n const text = uni.getElementById('text')!\r\n text.style.setProperty('color', 'red')\r\n },\r\n changeViewStyle() {\r\n const view = uni.getElementById('view')\r\n if (view !== null) {\r\n view.style.setProperty('width', '90%')\r\n view.style.setProperty('height', '50px')\r\n view.style.setProperty('background-color', '#007AFF')\r\n }\r\n },\r\n goMultipleRootNode() {\r\n uni.navigateTo({ url: '/pages/API/get-element-by-id/get-element-by-id-multiple-root-node' })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"createSelectorQuery":{"name":"## uni.createSelectorQuery() @createselectorquery","description":"\r\n返回一个SelectorQuery对象实例\r\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n#### SelectorQuery 的方法 @selectorquery-values \n\n#### in(component?) @in\n\r\n将选择器的选取范围更改为自定义组件component内\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| component | any \\| null | 否 | - | |\n##### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n#### select(selector) @select\n\r\n在当前页面下选择第一个匹配选择器selector的节点\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| selector | string | 是 | - | - |\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) | \n\n###### NodesRef 的方法 @nodesref-values \n\n##### boundingClientRect(callback?) @boundingclientrect\n\r\n添加节点的布局位置的查询请求,相对于显示区域,以像素为单位\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | Function \\| null | 否 | - | |\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n##### scrollOffset(callback) @scrolloffset\n\r\n添加节点的滚动位置查询请求,以像素为单位\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | |\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n##### fields(fields, callback) @fields\n\r\n获取节点的相关信息,需要获取的字段在fields中指定\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fields | [NodeField](#nodefield-values) | 是 | - | - |\n| callback | (result: any) => void | 是 | - | |\n###### NodeField 的属性值 @nodefield-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| id | boolean \\| null | 否 | - | |\n| dataset | boolean \\| null | 否 | - | |\n| rect | boolean \\| null | 否 | - | |\n| size | boolean \\| null | 否 | - | |\n| scrollOffset | boolean \\| null | 否 | - | |\n| properties | Array \\| null | 否 | - | |\n| computedStyle | Array \\| null | 否 | - | |\n| context | boolean \\| null | 否 | - | |\n\n###### NodeField 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| context | x | x | 4.0 |\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n##### context(callback) @context\n\r\n添加节点的 Context 对象查询请求\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | |\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n###### context 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |\n\n\n##### node(callback) @node\n\r\n获取 Node 节点实例。目前支持 Canvas 的获取。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) | \n\n\n\n\n\n#### selectAll(selector) @selectall\n\r\n在当前页面下选择匹配选择器selector的所有节点\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| selector | string | 是 | - | - |\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) | \n\n\n\n#### selectViewport() @selectviewport\n\r\n选择显示区域\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) | \n\n\n\n#### exec(callback) @exec\n\r\n执行所有的请求\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: Array\\) => void \\| null | 是 | - | - |\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| interface \\| null | 否 | \n\n\n","compatibility":"### createSelectorQuery 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","tutorial":"\n### 参见\n[createSelectorQuery](https://doc.dcloud.net.cn/uni-app-x/api/nodes-info.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.dom.nodes-info.createSelectorQuery)\n"},"nodes-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/nodes-info/nodes-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/nodes-info/nodes-info\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n left: \r\n {{nodeInfo.left}}\r\n \r\n \r\n top: \r\n {{nodeInfo.top}}\r\n \r\n \r\n right: \r\n {{nodeInfo.right}}\r\n \r\n \r\n bottom: \r\n {{nodeInfo.bottom}}\r\n \r\n \r\n width: \r\n {{nodeInfo.width}}\r\n \r\n \r\n height: \r\n {{nodeInfo.height}}\r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type NodeInfoType = {\r\n left : number | null,\r\n top : number | null,\r\n right : number | null,\r\n bottom : number | null,\r\n width : number | null,\r\n height : number | null,\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'createSelectorQuery',\r\n nodeInfoList: [] as NodeInfoType[],\r\n //供自动化测试使用\r\n // resizeRectValid: false\r\n }\r\n },\r\n onResize() {\r\n //供自动化测试使用\r\n /* var rect12Element = uni.getElementById(\"rect-1-2\")\r\n if(rect12Element != null) {\r\n var domRect = rect12Element.getBoundingClientRect()\r\n if(domRect.width > 100) {\r\n this.resizeRectValid = true\r\n }\r\n } */\r\n },\r\n methods: {\r\n getNodeInfo() {\r\n uni.createSelectorQuery().select('.rect1').boundingClientRect().exec((ret) => {\r\n this.nodeInfoList.length = 0\r\n const i = ret[0] as NodeInfo\r\n this.nodeInfoList.push({\r\n left: i.left,\r\n top: i.top,\r\n right: i.right,\r\n bottom: i.bottom,\r\n width: i.width,\r\n height: i.height,\r\n } as NodeInfoType)\r\n })\r\n },\r\n getAllNodeInfo() {\r\n uni.createSelectorQuery().selectAll('.rect').boundingClientRect().exec((ret) => {\r\n this.nodeInfoList.length = 0\r\n const array = ret[0] as NodeInfo[]\r\n array.forEach((i) => {\r\n this.nodeInfoList.push({\r\n left: i.left,\r\n top: i.top,\r\n right: i.right,\r\n bottom: i.bottom,\r\n width: i.width,\r\n height: i.height,\r\n } as NodeInfoType)\r\n })\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"showActionSheet":{"name":"## uni.showActionSheet(options) @showactionsheet","description":"从底部向上弹出操作菜单","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowActionSheetOptions](#showactionsheetoptions-values) | 是 | - | uni.showActionSheet函数参数定义 |\n#### ShowActionSheetOptions 的属性值 @showactionsheetoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string \\| null | 否 | - | |\n| alertText | string \\| null | 否 | - | |\n| itemList | Array\\ | 是 | - | 按钮的文字数组 |\n| itemColor | string \\| null | 否 | - | |\n| popover | interface \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | uni.showActionSheet成功回调函数定义 |\n| fail | Function \\| null | 否 | - | uni.showActionSheet成功回调函数定义 |\n| complete | Function \\| null | 否 | - | uni.showActionSheet成功回调函数定义 |\n","returnValue":"","compatibility":"### showActionSheet 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[showActionSheet]([](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showActionSheet)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/action-sheet/action-sheet.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/action-sheet/action-sheet\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n {{item.name}}\r\n \r\n \r\n \r\n \r\n \r\n 自定义itemColor\r\n \r\n \r\n \r\n 超长文本和空文本item\r\n \r\n \r\n \r\n 超过6个item\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'action-sheet',\r\n itemColorCustom: false,\r\n itemContentLarge: false,\r\n itemNumLargeSelect: false,\r\n items: [{\r\n value: '标题',\r\n name: '有标题'\r\n },\r\n {\r\n value: '',\r\n name: '无标题'\r\n },\r\n {\r\n value: '超长标题测试内容,测试超过显示最大范围之后的样式-超长标题测试内容,测试超过显示最大范围之后的样式',\r\n name: '超长标题'\r\n }\r\n ] as ItemType[],\r\n current: 0,\r\n }\r\n },\n onLoad(){\n uni.showActionSheet({\n title: \"onLoad 调用示例,请手动取消\",\n itemList:['item1', 'item2'],\n })\n },\r\n methods: {\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n for (let i = 0; i < this.items.length; i++) {\r\n if (this.items[i].value === e.detail.value) {\r\n this.current = i;\r\n break;\r\n }\r\n }\r\n },\r\n itemContentLargeChange: function (e : UniSwitchChangeEvent) {\r\n this.itemContentLarge = e.detail.value\r\n },\r\n itemColorChange: function (e : UniSwitchChangeEvent) {\r\n this.itemColorCustom = e.detail.value\r\n },\r\n itemNumLargeChange: function (e : UniSwitchChangeEvent) {\r\n this.itemNumLargeSelect = e.detail.value\r\n },\r\n actionSheetTap() {\r\n\r\n let itemInfo = ['item1', 'item2', 'item3', 'item4']\r\n\r\n if (this.itemContentLarge) {\r\n itemInfo = ['两个黄鹂鸣翠柳,一行白鹭上青天。窗含西岭千秋雪,门泊东吴万里船', '水光潋滟晴方好,山色空蒙雨亦奇。 欲把西湖比西子,淡妆浓抹总相宜', '']\r\n }\n\n if (this.itemNumLargeSelect) {\r\n // 大量选项测试,不能超过6个元素 https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet\r\n itemInfo = []\n for (var i = 1; i <= 10; i++) {\r\n itemInfo.push('两个黄鹂鸣翠柳,一行白鹭上青天');\r\n }\r\n }\r\n\r\n const that = this\r\n if (this.itemColorCustom) {\r\n uni.showActionSheet({\r\n title: this.items[this.current].value,\r\n itemList: itemInfo,\r\n itemColor: \"#ff00ff\",\r\n success: (e) => {\r\n console.log(e.tapIndex);\r\n uni.showToast({\r\n title: \"点击了第\" + e.tapIndex + \"个选项\",\r\n icon: \"none\"\r\n })\r\n },\r\n fail: (e) => {\r\n console.log(e);\r\n }\r\n })\r\n } else {\r\n uni.showActionSheet({\r\n title: this.items[this.current].value,\r\n itemList: itemInfo,\r\n success: (e) => {\r\n console.log(e.tapIndex);\r\n uni.showToast({\r\n title: \"点击了第\" + e.tapIndex + \"个选项\",\r\n icon: \"none\"\r\n })\r\n },\r\n fail: (e) => {\r\n console.log(e);\r\n uni.showToast({\r\n title: e.errMsg,\r\n icon: \"none\"\r\n })\r\n }\r\n })\r\n }\r\n },\r\n }\r\n }\r\n\n```\n\n:::"},"showLoading":{"name":"## uni.showLoading(options) @showloading","description":"显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowLoadingOptions](#showloadingoptions-values) | 是 | - | uni.showLoading参数定义 |\n#### ShowLoadingOptions 的属性值 @showloadingoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 是 | - | 提示的内容,长度与 icon 取值有关。 |\n| mask | boolean \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | uni.showLoading成功回调函数定义 |\n| fail | Function \\| null | 否 | - | uni.showLoading失败回调函数定义 |\n| complete | Function \\| null | 否 | - | uni.showLoading完成回调函数定义 |\n","returnValue":"","compatibility":"### showLoading 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[showLoading]([](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showloading))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showLoading)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/loading/loading.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/loading/loading\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n 是否显示透明蒙层-屏蔽点击事件\r\n \r\n \r\n \r\n \r\n 设置标题 \r\n \r\n \r\n \r\n \r\n \r\n {{ item.name }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 为方便演示,loading弹出3秒后自动关闭\r\n \r\n \r\n \r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string\r\n name : string\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'loading',\r\n items: [\r\n {\r\n value: 'null',\r\n name: '无标题',\r\n },\r\n {\r\n value: '三秒后自动关闭',\r\n name: '普通标题',\r\n },\r\n {\r\n value: '超长文本内容,测试超出范围-超长文本内容,测试超出范围-三秒后自动关闭',\r\n name: '长标题',\r\n },\r\n ] as ItemType[],\r\n current: 0,\r\n maskSelect: false,\r\n titleSelect: \"null\"\r\n }\r\n },\r\n onLoad(){\r\n uni.showLoading({\r\n \ttitle:'onLoad 调用示例,2秒后消失'\r\n })\r\n setTimeout(function() {\r\n uni.hideLoading()\r\n }, 2000);\r\n },\r\n methods: {\r\n\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n const selected = this.items.find((item) : boolean => {\r\n return item.value == e.detail.value\r\n })\r\n if (selected != null) {\r\n this.titleSelect = selected.value\r\n }\r\n },\r\n maskChange: function (e : UniSwitchChangeEvent) {\r\n this.maskSelect = e.detail.value\r\n },\r\n showLoading: function () {\r\n\r\n console.log(this.titleSelect)\r\n if (this.titleSelect == \"null\") {\r\n uni.showLoading({\r\n title: \"\",\r\n mask: this.maskSelect\r\n });\r\n } else {\r\n uni.showLoading({\r\n title: this.titleSelect,\r\n mask: this.maskSelect\r\n });\r\n }\r\n setTimeout(() => {\r\n this.hideLoading();\r\n }, 3000);\r\n },\r\n hideLoading: function () {\r\n uni.hideLoading();\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"showModal":{"name":"## uni.showModal(options) @showmodal","description":"显示模态弹窗,可以只有一个确定按钮,也可以同时有确定和取消按钮。类似于一个API整合了 html 中:alert、confirm。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowModalOptions](#showmodaloptions-values) | 是 | - | uni.showModal 参数定义 |\n#### ShowModalOptions 的属性值 @showmodaloptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string \\| null | 否 | - | |\n| content | string \\| null | 否 | - | |\n| showCancel | boolean \\| null | 否 | true
是否显示取消按钮,默认为 true | |\n| cancelText | string \\| null | 否 | - | |\n| cancelColor | string \\| null | 否 | - | |\n| confirmText | string \\| null | 否 | - | |\n| confirmColor | string \\| null | 否 | - | |\n| editable | boolean \\| null | 否 | false
是否显示输入框 | |\n| placeholderText | string \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | uni.showModal成功回调函数定义 |\n| fail | Function \\| null | 否 | - | uni.showModal失败回调函数定义 |\n| complete | Function \\| null | 否 | - | uni.showModal完成回调函数定义 |\n","returnValue":"","compatibility":"### showModal 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[showModal]([](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showmodal))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showModal)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/modal/modal.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/modal/modal\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{ item.name }}\r\n \r\n \r\n \r\n \r\n \r\n 是否显示取消按钮\r\n \r\n \r\n \r\n 定制取消文案\r\n \r\n \r\n \r\n 定制确认文案\r\n \r\n \r\n \r\n 是否显示输入框\r\n \r\n \r\n \r\n 是否定制输入提示词\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{ exeRet }}\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'modal',\r\n showCancelSelect: false,\r\n cancelTextSelect: false,\r\n confirmTextSelect: false,\r\n editableSelect: false,\r\n placeholderTextSelect: false,\r\n exeRet: \"\",\r\n items: [{\r\n value: '标题',\r\n name: '有标题'\r\n },\r\n {\r\n value: '',\r\n name: '无标题'\r\n },\r\n {\r\n value: '超长标题测试内容,测试超过显示最大范围之后的样式-超长标题测试内容,测试超过显示最大范围之后的样式',\r\n name: '超长标题'\r\n }\r\n ] as ItemType[],\r\n current: 0\r\n }\r\n },\r\n onLoad() {\r\n uni.showModal({\r\n title: \"onLoad 调用示例,请手动取消\",\r\n showCancel: false\r\n })\r\n },\r\n methods: {\r\n showCancelChange: function (e : UniSwitchChangeEvent) {\r\n this.showCancelSelect = e.detail.value\r\n },\r\n cancelTextChange: function (e : UniSwitchChangeEvent) {\r\n this.cancelTextSelect = e.detail.value\r\n },\r\n confirmTextChange: function (e : UniSwitchChangeEvent) {\r\n this.confirmTextSelect = e.detail.value\r\n },\r\n editableChange: function (e : UniSwitchChangeEvent) {\r\n this.editableSelect = e.detail.value\r\n },\r\n placeholderTextChange: function (e : UniSwitchChangeEvent) {\r\n this.placeholderTextSelect = e.detail.value\r\n },\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n for (let i = 0; i < this.items.length; i++) {\r\n if (this.items[i].value === e.detail.value) {\r\n this.current = i;\r\n break;\r\n }\r\n }\r\n },\r\n modalTap: function () {\r\n let cancelTextVal : string\r\n let cancelColorVal = ''\r\n if (this.cancelTextSelect) {\r\n cancelTextVal = \"修改后的取消文本\"\r\n cancelColorVal = \"#ff00ff\"\r\n } else {\r\n cancelTextVal = \"取消\"\r\n }\r\n\r\n let confirmTextVal = '确定'\r\n let confirmColorVal = ''\r\n if (this.confirmTextSelect) {\r\n confirmTextVal = \"修改后的确定文本\"\r\n confirmColorVal = \"#00ffff\"\r\n }\r\n\r\n let placeholderTextVal = ''\r\n let contentVal = \"弹窗内容,告知当前状态、信息和解决方法,描述文字尽量控制在三行内\"\r\n if (this.placeholderTextSelect) {\r\n placeholderTextVal = \"定制提示信息\"\r\n contentVal = \"\"\r\n }\r\n uni.showModal({\r\n title: this.items[this.current].value,\r\n editable: this.editableSelect,\r\n placeholderText: placeholderTextVal,\r\n content: contentVal,\r\n showCancel: this.showCancelSelect,\r\n cancelText: cancelTextVal,\r\n cancelColor: cancelColorVal,\r\n confirmText: confirmTextVal,\r\n confirmColor: confirmColorVal,\r\n success: (res) => {\r\n this.exeRet = JSON.stringify(res)\r\n },\r\n fail: (res) => {\r\n this.exeRet = JSON.stringify(res)\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"showToast":{"name":"## uni.showToast(options) @showtoast","description":"显示消息提示框","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ShowToastOptions](#showtoastoptions-values) | 是 | - | uni.showToast参数定义 |\n#### ShowToastOptions 的属性值 @showtoastoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 是 | - | 提示的内容,长度与 icon 取值有关。 |\n| icon | string \\| null | 否 | - | |\n| image | string \\| null | 否 | - | |\n| mask | boolean \\| null | 否 | - | |\n| duration | number \\| null | 否 | - | |\n| position | string \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | uni.showToast成功回调函数定义 |\n| fail | Function \\| null | 否 | - | uni.showToast失败回调函数定义 |\n| complete | Function \\| null | 否 | - | uni.showToast完成回调函数定义 |\n","returnValue":"","compatibility":"### showToast 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[showToast]([](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showtoast))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showToast)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/toast/toast.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/toast/toast\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{exeRet}}\r\n \r\n \r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'toast',\r\n exeRet: ''\r\n }\r\n },\r\n onLoad() {\r\n uni.showToast({\r\n title: 'onLoad 调用示例,2秒后消失'\r\n })\r\n setTimeout(function () {\r\n uni.hideToast()\r\n }, 2000);\r\n },\r\n methods: {\r\n toast1Tap: function () {\r\n uni.showToast({\r\n title: \"默认\",\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n toastTapIconError: function () {\r\n uni.showToast({\r\n title: \"默认\",\r\n icon: 'error',\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n toast2Tap: function () {\r\n uni.showToast({\r\n title: \"duration 3000\",\r\n duration: 3000,\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n toast3Tap: function () {\r\n uni.showToast({\r\n title: \"loading\",\r\n icon: \"loading\",\r\n duration: 5000,\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n toast4Tap: function () {\r\n uni.showToast({\r\n title: \"logo\",\r\n image: \"/static/uni.png\",\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n // #ifdef APP-PLUS\r\n toast5Tap: function () {\r\n uni.showToast({\r\n title: \"显示一段轻提示\",\r\n position: 'bottom',\r\n success: (res) => {\r\n this.exeRet = \"success:\" + JSON.stringify(res) + new Date()\r\n },\r\n fail: (res) => {\r\n this.exeRet = \"fail:\" + JSON.stringify(res)\r\n },\r\n })\r\n },\r\n // #endif\r\n hideToast: function () {\r\n uni.hideToast()\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"loadFontFace":{"name":"## uni.loadFontFace(options) @loadfontface","description":"\r\n动态加载网络字体\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [LoadFontFaceOptions](#loadfontfaceoptions-values) | 是 | - | - |\n#### LoadFontFaceOptions 的属性值 @loadfontfaceoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| global | boolean | 否 | - | 是否全局生效。微信小程序 '2.10.0'起支持全局生效,需在 app.vue 中调用。 |\n| family | string | 是 | - | 定义的字体名称 |\n| source | string | 是 | - | 字体资源的地址 |\n| desc | [LoadFontFaceOptionDesc](#loadfontfaceoptiondesc-values) | 否 | - | 可选的字体描述符 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult-values)) => void | 否 | - | 接口调用成功的回调函数 |\n| fail | (error: [LoadFontFaceError](#loadfontfaceerror-values)) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n\n##### LoadFontFaceOptionDesc 的属性值 @loadfontfaceoptiondesc-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| style | string \\| null | 否 | - | |\n| weight | string \\| null | 否 | - | |\n| variant | string \\| null | 否 | - | |\n\n##### AsyncApiSuccessResult 的属性值 @asyncapisuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### LoadFontFaceError 的属性值 @loadfontfaceerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 4 \\| 99 \\| 101 \\| 100001 \\| 100002 \\| 200001 \\| 300001 \\| 300002 | 是 | - | 错误码
- 4: 框架内部异常
- 99: page is not ready
- 101: 参数错误
- 100001: family is null
- 100002: source is null
- 200001: local font not found
- 300001: same source task is loading
- 300002: download fail |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| errMsg | string | 是 | - | 统一错误描述信息 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| name | string | 是 | - | - |\n| message | string | 是 | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n\n##### LoadFontFaceOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| global | √ | x | 4.0 |\n| family | √ | x | 4.0 |\n| source | √ | x | 4.0 |\n| desc | x | x | 4.0 |\n| success | √ | x | 4.0 |\n| fail | √ | x | 4.0 |\n| complete | √ | x | 4.0 |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 | \n","compatibility":"### loadFontFace 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | x | 4.0 |\n","tutorial":"\n### 参见\n[loadFontFace](https://doc.dcloud.net.cn/uni-app-x/api/load-font-face.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.load-font-face)\n"},"load-font-face":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/load-font-face/load-font-face.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/load-font-face/load-font-face\n>Template\n```vue\n\r\n \r\n \r\n 全局加载字体:\r\n font-family: uni.ttf\r\n \r\n {{\r\n uniIcon1\r\n }}\r\n \\ue100\r\n {{\r\n uniIcon2\r\n }}\r\n \\ue101\r\n \r\n 非全局加载字体:\r\n font-family: 阿里妈妈刀隶体-ttf\r\n (网络字体下载后生效)\r\n font-family:\r\n 阿里妈妈刀隶体-otf\r\n font-family: 阿里妈妈刀隶体-woff\r\n font-family: 阿里妈妈刀隶体-woff2\r\n \r\n \r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n uniIcon1: '\\ue100',\r\n uniIcon2: '\\ue101',\r\n }\r\n },\r\n onLoad() {\r\n uni.loadFontFace({\r\n global: true,\r\n family: 'UniFontFamily',\r\n source: \"url('/static/font/uni.ttf')\",\r\n success() {\r\n console.log('global loadFontFace uni.ttf success')\r\n },\r\n fail(error) {\r\n console.warn('global loadFontFace uni.ttf fail', error.errMsg)\r\n },\r\n })\r\n uni.loadFontFace({\r\n family: 'AlimamaDaoLiTiTTF',\r\n source:\r\n \"url('https://qiniu-web-assets.dcloud.net.cn/uni-app-x/static/font/AlimamaDaoLiTi.ttf')\",\r\n success() {\r\n console.log('loadFontFace Remote AlimamaDaoLiTi.ttf success')\r\n },\r\n fail(error) {\r\n console.warn('loadFontFace Remote AlimamaDaoLiTi.ttf fail', error.errMsg)\r\n },\r\n })\r\n uni.loadFontFace({\r\n family: 'AlimamaDaoLiTiOTF',\r\n source: \"url('/static/font/AlimamaDaoLiTi.otf')\",\r\n success() {\r\n console.log('loadFontFace AlimamaDaoLiTi.otf success')\r\n },\r\n fail(error) {\r\n console.warn('loadFontFace AlimamaDaoLiTi.otf fail', error.errMsg)\r\n },\r\n })\r\n uni.loadFontFace({\r\n family: 'AlimamaDaoLiTiWOFF',\r\n source: \"url('/static/font/AlimamaDaoLiTi.woff')\",\r\n success() {\r\n console.log('loadFontFace AlimamaDaoLiTi.woff success')\r\n },\r\n fail(error) {\r\n console.warn('loadFontFace AlimamaDaoLiTi.woff fail', error.errMsg)\r\n },\r\n })\r\n uni.loadFontFace({\r\n family: 'AlimamaDaoLiTiWOFF2',\r\n source: \"url('/static/font/AlimamaDaoLiTi.woff2')\",\r\n success() {\r\n console.log('loadFontFace AlimamaDaoLiTi.woff2 success')\r\n },\r\n fail(error) {\r\n console.warn('loadFontFace AlimamaDaoLiTi.woff2 fail', error.errMsg)\r\n },\r\n })\r\n },\r\n methods: {\r\n navigateToChild() {\r\n uni.navigateTo({\r\n url: '/pages/API/load-font-face/load-font-face-child',\r\n })\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"request":{"name":"## uni.request(param) @request","description":"发起网络请求。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| param | [RequestOptions\\](#requestoptions-values) | 是 | - | 网络请求参数 |\n#### RequestOptions\\ 的属性值 @requestoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string | 是 | - | 开发者服务器接口地址 |\n| data | any \\| null | 否 | null | |\n| header | interface \\| null | 否 | null | |\n| method | Union \\| null | 否 | \"GET\" | 请求方法
- GET GET方法请求一个指定资源的表示形式,使用 GET 的请求应该只被用于获取数据。
- POST POST方法用于将实体提交到指定的资源,通常导致在服务器上的状态变化或副作用。
- PUT PUT方法用有效载荷请求替换目标资源的所有当前表示。
- PATCH PATCH方法用于对资源应用部分修改。
- DELETE DELETE方法删除指定的资源。
- HEAD HEAD方法请求一个与GET请求的响应相同的响应,但没有响应体。
- OPTIONS OPTIONS 方法用于描述目标资源的通信选项。 |\n| timeout | number \\| null | 否 | 60000 | |\n| firstIpv4 | boolean \\| null | 否 | false | |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RequestTask](#requesttask-values) | \n\n#### RequestTask 的方法 @requesttask-values \n\n#### abort() @abort\n中断网络请求。\n\n\n##### abort 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | x |\n\n\n##### 参见\n[abort](https://uniapp.dcloud.net.cn/api/request/request.html#request)\n","compatibility":"### request 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[request](https://uniapp.dcloud.net.cn/api/request/request.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.request)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/request/request.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/request/request\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n 地址 : {{ host + url}}\r\n 请求方式 : {{method}}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 设置请求方式\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 请求返回错误码的接口(默认为GET)\r\n \r\n \r\n \r\n \r\n \r\n \r\n 请求不同header的接口(默认为GET)\r\n \r\n \r\n \r\n \r\n \r\n \r\n 请求不同content-type的接口(默认为GET)\r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n POST请求(有body)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n const duration = 2000\r\n const methodMap = {\r\n \"GET\": \"/api/http/method/get\",\r\n \"POST\": \"/api/http/method/post\",\r\n \"PUT\": \"/api/http/method/put\",\r\n \"DELETE\": \"/api/http/method/delete\",\r\n \"PATCH\": \"/api/http/method/patch\",\r\n \"OPTIONS\": \"/api/http/method/options\",\r\n \"HEAD\": \"/api/http/method/head\"\r\n }\r\n\r\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'request',\r\n res: '',\r\n task: null as RequestTask | null,\r\n host: \"https://request.dcloud.net.cn\",\r\n url: \"/api/http/method/get\",\r\n method: \"GET\" as RequestMethod | null,\r\n data: null as any | null,\r\n header: null as UTSJSONObject | null,\r\n errorCodeUrls: [\r\n \"/api/http/statusCode/200\",\r\n \"/api/http/statusCode/204\",\r\n \"/api/http/statusCode/301\",\r\n \"/api/http/statusCode/302\",\r\n \"/api/http/statusCode/307\",\r\n \"/api/http/statusCode/400\",\r\n \"/api/http/statusCode/401\",\r\n \"/api/http/statusCode/403\",\r\n \"/api/http/statusCode/404\",\r\n \"/api/http/statusCode/405\",\r\n \"/api/http/statusCode/500\",\r\n \"/api/http/statusCode/502\",\r\n \"/api/http/statusCode/503\",\r\n \"/api/http/statusCode/504\",\r\n ],\r\n headerUrls: [\r\n \"/api/http/header/ua\",\r\n \"/api/http/header/referer\",\r\n \"/api/http/header/requestCookie\",\r\n \"/api/http/header/setCookie\",\r\n \"/api/http/header/deleteCookie\"\r\n ],\r\n contentTypeUrls: [\r\n \"/api/http/contentType/text/plain\",\r\n \"/api/http/contentType/text/html\",\r\n \"/api/http/contentType/text/xml\",\r\n \"/api/http/contentType/image/gif\",\r\n \"/api/http/contentType/image/jpeg\",\r\n \"/api/http/contentType/image/png\",\r\n \"/api/http/contentType/application/json\",\r\n \"/api/http/contentType/application/octetStream\",\r\n ],\r\n postUrls: [\r\n \"/api/http/contentType/json\",\r\n \"/api/http/contentType/xWwwFormUrlencoded\",\r\n ],\r\n //自动化测试例专用\r\n jest_result: false\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n changeMethod(e : RequestMethod) {\r\n this.method = e;\r\n this.url = methodMap[e] as string;\r\n this.data = null;\r\n this.header = null;\r\n },\r\n changeUrl(e : string) {\r\n this.method = \"GET\";\r\n this.url = e;\r\n this.data = null;\r\n this.header = null;\r\n },\r\n changeUrlFromPost(e : string) {\r\n this.method = \"POST\";\r\n this.url = e;\r\n switch (e) {\r\n case \"/api/http/contentType/json\":\r\n this.header = {\r\n \"Content-Type\": \"application/json\"\r\n };\r\n this.data = {\r\n \"hello\": \"world\"\r\n };\r\n break;\r\n case \"/api/http/contentType/xWwwFormUrlencoded\":\r\n this.header = {\r\n \"Content-Type\": \"application/x-www-form-urlencoded\"\r\n };\r\n this.data = \"hello=world\";\r\n break;\r\n }\r\n },\r\n sendRequest() {\r\n uni.showLoading({\r\n title: \"请求中...\"\r\n })\r\n this.task = uni.request({\r\n url: this.host + this.url,\r\n // dataType: \"json\",\r\n // responseType: \"json\",\r\n method: this.method,\r\n data: this.data,\r\n header: this.header,\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: (res) => {\r\n console.log('request success', JSON.stringify(res.data))\r\n console.log('request success header is :', JSON.stringify(res.header))\r\n uni.showToast({\r\n title: '请求成功',\r\n icon: 'success',\r\n mask: true,\r\n duration: duration\r\n });\r\n this.res = '请求结果 : ' + JSON.stringify(res);\r\n },\r\n fail: (err) => {\r\n console.log('request fail', err);\r\n uni.showModal({\r\n content: err.errMsg,\r\n showCancel: false\r\n });\r\n },\r\n complete: () => {\r\n uni.hideLoading()\r\n },\r\n });\r\n },\r\n //自动化测试例专用\r\n jest_request() {\r\n uni.request({\r\n url: this.host + this.url,\r\n // dataType: \"json\",\r\n // responseType: \"json\",\r\n method: this.method,\r\n data: this.data,\r\n header: this.header,\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_set_cookie() {\r\n uni.request({\r\n url: this.host + \"/api/http/header/setCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_request(true)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_delete_cookie() {\r\n uni.request({\r\n url: this.host + \"/api/http/header/deleteCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_request(false)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_cookie_request(needCookie : boolean) {\r\n uni.request({\r\n url: this.host + \"/api/http/header/requestCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: (res) => {\r\n const requestCookie = (res.data as UTSJSONObject).getJSON(\"data\")?.getAny(\"requestCookie\")\r\n console.log(\"requestCookie \", requestCookie);\r\n if (requestCookie instanceof Array) {\r\n this.jest_result = needCookie ? requestCookie.length > 0 : requestCookie.length == 0\r\n } else {\r\n this.jest_result = needCookie ? (requestCookie as UTSJSONObject).toMap().size > 0 : (requestCookie as UTSJSONObject).toMap().size == 0\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n }\r\n }\r\n\n```\n\n:::"},"uploadFile":{"name":"## uni.uploadFile(options) @uploadfile","description":"将本地资源上传到开发者服务器。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UploadFileOptions](#uploadfileoptions-values) | 是 | - | - |\n#### UploadFileOptions 的属性值 @uploadfileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string | 是 | - | 开发者服务器 url |\n| filePath | string \\| null | 否 | null | |\n| name | string \\| null | 否 | null | |\n| files | Array \\| null | 否 | null | |\n| header | interface \\| null | 否 | null | |\n| formData | interface \\| null | 否 | null | |\n| timeout | number \\| null | 否 | 120000 | |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UploadTask](#uploadtask-values) | \n\n#### UploadTask 的方法 @uploadtask-values \n\n#### abort() @abort\n中断上传任务。\n\n\n##### abort 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | x |\n\n\n##### 参见\n[abort](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听上传进度变化。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnProgressUpdateResult](#onprogressupdateresult-values)) => void | 是 | - | - |\n###### OnProgressUpdateResult 的属性值 @onprogressupdateresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| progress | number | 是 | - | 上传进度百分比 |\n| totalBytesSent | number | 是 | - | 已经上传的数据长度,单位 Bytes |\n| totalBytesExpectedToSend | number | 是 | - | 预期需要上传的数据总长度,单位 Bytes |\n\n\n##### onProgressUpdate 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n\n\n##### 参见\n[onProgressUpdate](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n","compatibility":"### uploadFile 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[uploadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.upload-file)\n"},"upload-file":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/upload-file/upload-file.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/upload-file/upload-file\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n + 选择图片\r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'uploadFile',\r\n imageSrc: '',\r\n task: null as UploadTask | null,\r\n //自动化测试例专用\r\n jest_result: false,\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n this.imageSrc = '';\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n chooseImage: function () {\r\n uni.chooseImage({\r\n count: 1,\r\n sizeType: ['compressed'],\r\n sourceType: ['album'],\r\n success: (res) => {\r\n console.log('chooseImage success, temp path is', res.tempFilePaths[0])\r\n var imageSrc = res.tempFilePaths[0]\r\n uni.showLoading({\r\n title: '上传中'\r\n })\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload', //仅为示例,非真实的接口地址\r\n filePath: imageSrc,\r\n name: 'file',\r\n formData: {\r\n 'user': 'test'\r\n },\r\n success: (res) => {\r\n console.log('uploadImage success, res is:', res)\r\n uni.hideLoading();\r\n uni.showToast({\r\n title: '上传成功',\r\n icon: 'success',\r\n duration: 1000\r\n })\r\n this.imageSrc = imageSrc\r\n },\r\n fail: (err) => {\r\n console.log('uploadImage fail', err);\r\n uni.hideLoading();\r\n uni.showModal({\r\n content: err.errMsg,\r\n showCancel: false\r\n });\r\n },\r\n });\r\n },\r\n fail: (err) => {\r\n console.log('chooseImage fail', err)\r\n }\r\n })\r\n },\r\n //自动化测试例专用\r\n jest_uploadFile() {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload', //仅为示例,非真实的接口地址\r\n filePath: imageSrc,\r\n name: 'file',\r\n formData: {\r\n 'user': 'test'\r\n },\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\r\n jest_set_cookie() {\r\n uni.request({\r\n url: \"https://request.dcloud.net.cn/api/http/header/setCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_upload(true)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n\r\n jest_delete_cookie() {\r\n uni.request({\r\n url: \"https://request.dcloud.net.cn/api/http/header/deleteCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_upload(false)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_cookie_upload(needCookie : boolean) {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://request.dcloud.net.cn/api/http/header/upload',\r\n filePath: imageSrc,\r\n name: 'file',\r\n success: (res : UploadFileSuccess) => {\r\n const data = JSON.parseObject(res.data)\r\n const errCode = data?.getNumber(\"errCode\")\r\n if (errCode != null && errCode == 1000) {\r\n this.jest_result = needCookie ? false : true;\r\n } else {\r\n this.jest_result = needCookie ? true : false;\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\r\n jest_files_upload() {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload',\r\n files: [\r\n {\r\n name: \"file1\",\r\n uri: imageSrc\r\n } as UploadFileOptionFiles,\r\n {\r\n name: \"file2\",\r\n uri: imageSrc\r\n } as UploadFileOptionFiles\r\n ],\r\n success: (res : UploadFileSuccess) => {\r\n if (res.statusCode == 200) {\r\n this.jest_result = true;\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"downloadFile":{"name":"## uni.downloadFile(options) @downloadfile","description":"下载文件资源到本地,客户端直接发起一个 HTTP GET 请求,返回文件的本地临时路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [DownloadFileOptions](#downloadfileoptions-values) | 是 | - | - |\n#### DownloadFileOptions 的属性值 @downloadfileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string | 是 | - | 下载资源的 url |\n| header | interface \\| null | 否 | null | |\n| filePath | string \\| null | 否 | null | |\n| timeout | number \\| null | 否 | 120000 | |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [DownloadTask](#downloadtask-values) | \n\n#### DownloadTask 的方法 @downloadtask-values \n\n#### abort() @abort\n中断下载任务。\n\n\n##### abort 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | x |\n\n\n##### 参见\n[abort](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听下载进度变化。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnProgressDownloadResult](#onprogressdownloadresult-values)) => void | 是 | - | - |\n###### OnProgressDownloadResult 的属性值 @onprogressdownloadresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| progress | number | 是 | - | 下载进度百分比 |\n| totalBytesWritten | number | 是 | - | 已经下载的数据长度,单位 Bytes |\n| totalBytesExpectedToWrite | number | 是 | - | 预期需要下载的数据总长度,单位 Bytes |\n\n\n##### onProgressUpdate 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n\n\n##### 参见\n[onProgressUpdate](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n","compatibility":"### downloadFile 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[downloadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.download-file)\n"},"download-file":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/download-file/download-file.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/download-file/download-file\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 点击按钮下载服务端示例图片(下载网络文件到本地临时目录)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'downloadFile',\r\n imageSrc: '',\r\n task: null as DownloadTask | null,\r\n //自动化测试例专用\r\n jest_result: false\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n // this.imageSrc = '';\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n downloadImage: function () {\r\n uni.showLoading({\r\n title: '下载中'\r\n })\r\n var self = this\r\n this.task = uni.downloadFile({\r\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\r\n success: (res) => {\r\n console.log('downloadFile success, res is', res.tempFilePath)\r\n self.imageSrc = res.tempFilePath;\r\n uni.hideLoading();\r\n },\r\n fail: (err) => {\r\n console.log('downloadFile fail, err is:', err)\r\n uni.hideLoading();\r\n }\r\n });\r\n this.task?.onProgressUpdate((update) => {\r\n console.log(\"progress : \", update.progress);\r\n })\r\n },\r\n //自动化测试例专用\r\n jest_downloadFile() {\r\n uni.downloadFile({\r\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\r\n success: () => {\r\n this.jest_result = true\r\n },\r\n fail: () => {\r\n this.jest_result = false\r\n }\r\n });\r\n },\n\n jest_set_cookie(){\n uni.request({\n url: \"https://request.dcloud.net.cn/api/http/header/setCookie\",\n method: \"GET\",\n timeout: 6000,\n sslVerify: false,\n withCredentials: true,\n firstIpv4: false,\n success: () => {\n this.jest_cookie_download(true)\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n\n jest_delete_cookie(){\n uni.request({\n url: \"https://request.dcloud.net.cn/api/http/header/deleteCookie\",\n method: \"GET\",\n timeout: 6000,\n sslVerify: false,\n withCredentials: true,\n firstIpv4: false,\n success: () => {\n this.jest_cookie_download(false)\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n jest_cookie_download(needCookie: boolean){\n uni.downloadFile({\n url: \"https://request.dcloud.net.cn/api/http/header/download\",\n success: () => {\n this.jest_result = needCookie ? true : false;\n },\n fail: () => {\n this.jest_result = needCookie ? false : true;\n }\n });\n }\r\n }\r\n }\r\n\n```\n\n:::"},"getNetworkType":{"name":"## uni.getNetworkType(options) @getnetworktype","description":"获取网络类型","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetNetworkTypeOptions](#getnetworktypeoptions-values) | 是 | - | - |\n#### GetNetworkTypeOptions 的属性值 @getnetworktypeoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"","compatibility":"### getNetworkType 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getNetworkType](http://uniapp.dcloud.io/api/system/network?id=getnetworktype)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.get-network-type)\n"},"get-network-type":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-network-type/get-network-type.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-network-type/get-network-type\n>Template\n```vue\n\r\n \r\n \r\n \r\n 网络状态\r\n \r\n 未获取\r\n 请点击下面按钮获取网络状态\r\n \r\n \r\n {{networkType}}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'getNetworkType',\r\n hasNetworkType: false,\r\n networkType: '',\r\n connectedWifi: '',\r\n //自动化测试例专用\r\n jest_result: false,\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload: function () {\r\n this.networkType = '';\r\n this.hasNetworkType = false;\r\n },\r\n methods: {\r\n getNetworkType: function () {\r\n uni.getNetworkType({\r\n success: (res) => {\r\n console.log(res)\r\n this.hasNetworkType = true;\r\n this.networkType = res.networkType\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n content: '获取失败!',\r\n showCancel: false\r\n })\r\n }\r\n })\r\n },\r\n clear: function () {\r\n this.hasNetworkType = false;\r\n this.networkType = '';\r\n this.connectedWifi = '';\r\n },\r\n //自动化测试例专用\r\n jest_getNetworkType() {\r\n uni.getNetworkType({\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"connectSocket":{"name":"## connectSocket(options) @connectsocket","description":"创建一个 WebSocket 连接。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ConnectSocketOptions](#connectsocketoptions-values) | 是 | - | - |\n#### ConnectSocketOptions 的属性值 @connectsocketoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| url | string | 是 | - | 开发者服务器接口地址,必须是 wss 协议,且域名必须是后台配置的合法域名 |\n| header | interface \\| null | 否 | null | |\n| protocols | Array \\| null | 否 | null | |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [SocketTask](#sockettask-values) | \n\n#### SocketTask 的方法 @sockettask-values \n\n#### send(options) @send\n通过 WebSocket 连接发送数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions-values) | 是 | - | - |\n###### SendSocketMessageOptions 的属性值 @sendsocketmessageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | any | 是 | - | 需要发送的内容 |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n\n\n##### send 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[send](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-send)\n\n#### close(options) @close\n关闭 WebSocket 连接\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [CloseSocketOptions](#closesocketoptions-values) | 是 | - | - |\n###### CloseSocketOptions 的属性值 @closesocketoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| code | number \\| null | 否 | 1000 | |\n| reason | string \\| null | 否 | \"\" | |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n\n\n##### close 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[close](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-close)\n\n#### onOpen(callback) @onopen\n监听 WebSocket 连接打开事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketOpenCallbackResult](#onsocketopencallbackresult-values)) => void | 是 | - | - |\n###### OnSocketOpenCallbackResult 的属性值 @onsocketopencallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| header | any | 是 | - | 连接成功的 HTTP 响应 Header |\n\n\n##### onOpen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[onOpen](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onopen)\n\n#### onClose(callback) @onclose\n监听 WebSocket 连接关闭事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n\n##### onClose 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[onClose](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onclose)\n\n#### onError(callback) @onerror\n监听 WebSocket 错误\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 是 | - | - |\n\n##### onError 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[onError](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onerror)\n\n#### onMessage(callback) @onmessage\n监听 WebSocket 接受到服务器的消息事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketMessageCallbackResult](#onsocketmessagecallbackresult-values)) => void | 是 | - | - |\n###### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | any | 是 | - | 服务器返回的消息 |\n\n\n##### onMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n\n\n##### 参见\n[onMessage](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onmessage)\n","compatibility":"### connectSocket 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[connectSocket](https://uniapp.dcloud.net.cn/api/request/websocket.html#connectsocket)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.connectSocket)\n"},"onSocketOpen":{"name":"## onSocketOpen(options) @onsocketopen","description":"监听WebSocket连接打开事件。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | (result: [OnSocketOpenCallbackResult](#onsocketopencallbackresult-values)) => void | 是 | - | - |","returnValue":"","compatibility":"### onSocketOpen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[onSocketOpen](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketopen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketOpen)\n"},"onSocketError":{"name":"## onSocketError(callback) @onsocketerror","description":"下载文件资源到本地,客户端直接发起一个 HTTP GET 请求,返回文件的本地临时路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketErrorCallbackResult](#onsocketerrorcallbackresult-values)) => void | 是 | - | - |\n#### OnSocketErrorCallbackResult 的属性值 @onsocketerrorcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | 错误信息 |\n","returnValue":"","compatibility":"### onSocketError 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[onSocketError](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketerror)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketError)\n"},"sendSocketMessage":{"name":"## sendSocketMessage(options) @sendsocketmessage","description":"通过 WebSocket 连接发送数据,需要先 uni.connectSocket,并在 uni.onSocketOpen 回调之后才能发送。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions-values) | 是 | - | - |\n#### SendSocketMessageOptions 的属性值 @sendsocketmessageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | any | 是 | - | 需要发送的内容 |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"","compatibility":"### sendSocketMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[sendSocketMessage](https://uniapp.dcloud.net.cn/api/request/websocket.html#sendsocketmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.sendSocketMessage)\n"},"onSocketMessage":{"name":"## onSocketMessage(callback) @onsocketmessage","description":"监听WebSocket接受到服务器的消息事件。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketMessageCallbackResult](#onsocketmessagecallbackresult-values)) => void | 是 | - | - |\n#### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| data | any | 是 | - | 服务器返回的消息 |\n","returnValue":"","compatibility":"### onSocketMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[onSocketMessage](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketMessage)\n"},"closeSocket":{"name":"## closeSocket(options) @closesocket","description":"关闭 WebSocket 连接。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [CloseSocketOptions](#closesocketoptions-values) | 是 | - | - |\n#### CloseSocketOptions 的属性值 @closesocketoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| code | number \\| null | 否 | 1000 | |\n| reason | string \\| null | 否 | \"\" | |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"","compatibility":"### closeSocket 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[closeSocket](https://uniapp.dcloud.net.cn/api/request/websocket.html#closesocket)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.closeSocket)\n"},"onSocketClose":{"name":"## onSocketClose(callback) @onsocketclose","description":"监听WebSocket关闭。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnSocketCloseCallbackResult](#onsocketclosecallbackresult-values)) => void | 是 | - | - |\n#### OnSocketCloseCallbackResult 的属性值 @onsocketclosecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| code | number | 是 | - | 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。\t |\n| reason | string | 是 | - | 一个可读的字符串,表示连接被关闭的原因。\t |\n","returnValue":"","compatibility":"### onSocketClose 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[onSocketClose](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketclose)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketClose)\n"},"websocket-global":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/websocket-global/websocket-global.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/websocket-global/websocket-global\n>Template\n```vue\n\r\n \r\n \r\n \r\n {{ showMsg }}\r\n \r\n \r\n \r\n 发送消息后会收到一条服务器返回的消息(与发送的消息内容一致)\r\n \r\n \r\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n connected: false,\r\n connecting: false,\r\n msg: '',\r\n roomId: '',\r\n platform: '',\r\n }\r\n },\r\n computed: {\r\n showMsg() : string {\r\n if (this.connected) {\r\n if (this.msg.length > 0) {\r\n return '收到消息:' + this.msg\r\n } else {\r\n return '等待接收消息'\r\n }\r\n } else {\r\n return '尚未连接'\r\n }\r\n },\r\n },\r\n onLoad() {\r\n this.platform = uni.getSystemInfoSync().platform\r\n },\r\n onUnload() {\r\n uni.closeSocket({\r\n code: 1000,\r\n reason: 'close reason from client',\r\n success: (res : any) => {\r\n console.log('uni.closeSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n console.log('uni.closeSocket fail', err)\r\n },\r\n } as CloseSocketOptions)\r\n uni.hideLoading()\r\n },\r\n methods: {\r\n connect() {\r\n if (this.connected || this.connecting) {\r\n uni.showModal({\r\n content: '正在连接或者已经连接,请勿重复连接',\r\n showCancel: false,\r\n })\r\n return\r\n }\r\n this.connecting = true\r\n uni.showLoading({\r\n title: '连接中...',\r\n })\r\n uni.connectSocket({\r\n url: 'ws://websocket.dcloud.net.cn',\r\n header: null,\r\n protocols: null,\r\n success: (res : any) => {\r\n // 这里是接口调用成功的回调,不是连接成功的回调,请注意\r\n console.log('uni.connectSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n // 这里是接口调用失败的回调,不是连接失败的回调,请注意\r\n console.log('uni.connectSocket fail', err)\r\n },\r\n })\r\n uni.onSocketOpen((res) => {\r\n this.connecting = false\r\n this.connected = true\r\n uni.hideLoading()\r\n\r\n uni.showToast({\r\n icon: 'none',\r\n title: '连接成功',\r\n })\r\n console.log('onOpen', res)\r\n })\r\n uni.onSocketError((err) => {\r\n this.connecting = false\r\n this.connected = false\r\n uni.hideLoading()\r\n\r\n uni.showModal({\r\n content: '连接失败,可能是websocket服务不可用,请稍后再试',\r\n showCancel: false,\r\n })\r\n console.log('onError', err)\r\n })\r\n uni.onSocketMessage((res) => {\r\n this.msg = res.data as string\r\n console.log('onMessage', res)\r\n })\r\n uni.onSocketClose((res) => {\r\n this.connected = false\r\n this.msg = ''\r\n console.log('onClose', res)\r\n })\r\n },\r\n send() {\r\n uni.sendSocketMessage({\r\n data:\r\n 'from ' +\r\n this.platform +\r\n ' : ' +\r\n parseInt((Math.random() * 10000).toString()).toString(),\r\n success: (res : any) => {\r\n console.log(res)\r\n },\r\n fail: (err : any) => {\r\n console.log(err)\r\n },\r\n } as SendSocketMessageOptions)\r\n },\r\n close() {\r\n uni.closeSocket({\r\n code: 1000,\r\n reason: 'close reason from client',\r\n success: (res : any) => {\r\n console.log('uni.closeSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n console.log('uni.closeSocket fail', err)\r\n },\r\n } as CloseSocketOptions)\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"getSystemInfo":{"name":"## uni.getSystemInfo(options) @getsysteminfo","description":"异步获取系统信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetSystemInfoOptions](#getsysteminfooptions-values) | 是 | - | - |\n#### GetSystemInfoOptions 的属性值 @getsysteminfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"","compatibility":"### getSystemInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getSystemInfo](http://uniapp.dcloud.io/api/system/info?id=getsysteminfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-info.getSystemInfo)\n"},"getSystemInfoSync":{"name":"## uni.getSystemInfoSync() @getsysteminfosync","description":"同步获取系统信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetSystemInfoResult](#getsysteminforesult-values) | \n\n#### GetSystemInfoResult 的属性值 @getsysteminforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SDKVersion | string | 是 | - | 客户端基础库版本 |\n| appId | string | 是 | - | `manifest.json` 中应用appid。 |\n| appLanguage | string | 是 | - | 应用设置的语言。 |\n| appName | string | 是 | - | `manifest.json` 中应用名称。 |\n| appVersion | string | 是 | - | `manifest.json` 中应用版本名称。 |\n| appVersionCode | string | 是 | - | `manifest.json` 中应用版本名号。 |\n| brand | string | 是 | - | 手机品牌。 |\n| browserName | string | 是 | - | 浏览器名称。`App` 端是系统 webview 的名字,比如 wkwebview、chrome。小程序端为空 |\n| browserVersion | string | 是 | - | 浏览器版本、webview 版本。 |\n| deviceId | string | 是 | - | 设备 ID |\n| deviceBrand | string | 是 | - | 设备品牌。如:`apple`、`huawei`。 |\n| deviceModel | string | 是 | - | 设备型号 |\n| deviceType | \"phone\" \\| \"pad\" \\| \"tv\" \\| \"watch\" \\| \"pc\" \\| \"null\" \\| \"car\" \\| \"vr\" \\| \"appliance\" | 是 | - | 设备类型。 |\n| devicePixelRatio | number | 是 | - | 设备像素比 |\n| deviceOrientation | \"portrait\" \\| \"landscape\" | 是 | - | 设备方向。 |\n| language | string | 是 | - | 程序设置的语言 |\n| model | string | 是 | - | 手机型号 |\n| osName | \"ios\" \\| \"android\" \\| \"mac\" \\| \"windows\" \\| \"linux\" | 是 | - | 系统名称\t |\n| osVersion | string | 是 | - | 操作系统版本。如 ios 版本,andriod 版本 |\n| osLanguage | string | 是 | - | 操作系统语言 |\n| osTheme | \"light\" \\| \"dark\" | 否 | - | 操作系统主题
|\n| pixelRatio | number | 是 | - | 设备像素比 |\n| platform | \"ios\" \\| \"android\" \\| \"mac\" \\| \"windows\" \\| \"linux\" | 是 | - | 客户端平台 |\n| screenWidth | number | 是 | - | 屏幕宽度 |\n| screenHeight | number | 是 | - | 屏幕高度 |\n| statusBarHeight | number | 是 | - | 状态栏的高度 |\n| system | string | 是 | - | 操作系统版本 |\n| safeArea | [SafeArea](#safearea-values) | 是 | - | 在竖屏正方向下的安全区域 |\n| safeAreaInsets | [SafeAreaInsets](#safeareainsets-values) | 是 | - | 在竖屏正方向下的安全区域插入位置 |\n| ua | string | 是 | - | 用户标识。小程序端为空 |\n| ~~uniCompileVersion~~ | string | 是 | - | uni 编译器版本 |\n| uniCompilerVersion | string | 是 | - | uni 编译器版本 |\n| uniPlatform | \"app\" \\| \"web\" \\| \"mp-weixin\" \\| \"mp-alipay\" \\| \"mp-baidu\" \\| \"mp-toutiao\" \\| \"mp-lark\" \\| \"mp-qq\" \\| \"mp-kuaishou\" \\| \"mp-jd\" \\| \"mp-360\" \\| \"quickapp-webview\" \\| \"quickapp-webview-union\" \\| \"quickapp-webview-huawei\" | 是 | - | uni-app 运行平台。 |\n| uniRuntimeVersion | string | 是 | - | uni 运行时版本 |\n| ~~uniCompileVersionCode~~ | number | 是 | - | uni 编译器版本号 |\n| uniCompilerVersionCode | number | 是 | - | uni 编译器版本号 |\n| uniRuntimeVersionCode | number | 是 | - | uni 运行时版本号 |\n| ~~version~~ | string | 是 | - | 引擎版本号。已废弃,仅为了向下兼容保留 |\n| romName | string | 是 | - | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios` |\n| romVersion | string | 是 | - | rom 版本号。Android 部分机型获取不到值。iOS 恒为 `ios 版本号` |\n| windowWidth | number | 是 | - | 可使用窗口宽度 |\n| windowHeight | number | 是 | - | 可使用窗口高度 |\n| windowTop | number | 是 | - | 可使用窗口的顶部位置 |\n| windowBottom | number | 是 | - | 可使用窗口的底部位置 |\n| osAndroidAPILevel | number \\| null | 否 | - | |\n\n##### SafeArea 的属性值 @safearea-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左上角横坐标 |\n| right | number | 是 | - | 安全区域右下角横坐标 |\n| top | number | 是 | - | 安全区域左上角纵坐标 |\n| bottom | number | 是 | - | 安全区域右下角纵坐标 |\n| width | number | 是 | - | 安全区域的宽度,单位逻辑像素 |\n| height | number | 是 | - | 安全区域的高度,单位逻辑像素 |\n\n##### SafeAreaInsets 的属性值 @safeareainsets-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左侧插入位置 |\n| right | number | 是 | - | 安全区域右侧插入位置 |\n| top | number | 是 | - | 安全区顶部插入位置 |\n| bottom | number | 是 | - | 安全区域底部插入位置 |\n\n##### GetSystemInfoResult 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| osTheme | √ | x | - |\n| osAndroidAPILevel | √ | x | - |\n","compatibility":"### getSystemInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getSystemInfoSync](http://uniapp.dcloud.io/api/system/info?id=getsysteminfosync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-info.getSystemInfoSync)\n"},"get-system-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-system-info/get-system-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-system-info/get-system-info\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{\r\n item.label\r\n }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getSystemInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n methods: {\r\n getSystemInfo: function () {\r\n uni.getSystemInfo({\r\n success: (res) => {\r\n this.items = [] as Item[];\r\n for (const key in res) {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n }\r\n },\r\n })\r\n },\r\n getSystemInfoSync: function () {\r\n this.items = [] as Item[];\r\n const res = uni.getSystemInfoSync()\r\n for (const key in res) {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n }\r\n },\r\n //自动化测试例专用\r\n jest_getSystemInfo() : GetSystemInfoResult {\r\n return uni.getSystemInfoSync();\r\n },\r\n }\r\n }\r\n\n```\n\n:::"},"getDeviceInfo":{"name":"## uni.getDeviceInfo(options?) @getdeviceinfo","description":"获取设备信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetDeviceInfoOptions](#getdeviceinfooptions-values) | 否 | 包含所有字段的过滤对象 | [options=包含所有字段的过滤对象\\] 过滤的字段对象, 不传参数默认为获取全部字段。 |\n#### GetDeviceInfoOptions 的属性值 @getdeviceinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filter | Array\\ | 是 | - | 过滤字段的字符串数组,假如要获取指定字段,传入此数组。 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetDeviceInfoResult](#getdeviceinforesult-values) | \n\n#### GetDeviceInfoResult 的属性值 @getdeviceinforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| brand | string | 否 | - | 设备品牌 |\n| deviceBrand | string | 否 | - | 设备品牌 |\n| deviceId | string | 否 | - | 设备 id 。由 uni-app 框架生成并存储,清空 Storage 会导致改变 |\n| model | string | 否 | - | 设备型号\t |\n| deviceModel | string | 否 | - | 设备型号\t |\n| deviceType | string | 否 | - | 设备类型phone、pad、pc\t |\n| deviceOrientation | string | 否 | - | 设备方向 竖屏 portrait、横屏 landscape\t |\n| devicePixelRatio | string | 否 | - | 设备像素比\t |\n| system | string | 否 | - | 操作系统及版本\t |\n| platform | string | 否 | - | 客户端平台\t |\n| isRoot | boolean | 否 | - | 是否root |\n| isSimulator | boolean | 否 | - | 是否是模拟器 |\n| isUSBDebugging | boolean | 否 | - | adb是否开启 |\n\n##### GetDeviceInfoResult 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| isUSBDebugging | √ | x | - |\n","compatibility":"### getDeviceInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getDeviceInfo](https://uniapp.dcloud.net.cn/api/system/getDeviceInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-device-info)\n"},"get-device-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-device-info/get-device-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-device-info/get-device-info\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{\r\n item.label\r\n }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { setDevicePixelRatio } from '@/store/index.uts'\r\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getDeviceInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n methods: {\r\n getDeviceInfo: function () {\r\n const res = uni.getDeviceInfo();\r\n // 获取像素比, 供截图对比使用\r\n setDevicePixelRatio(res.devicePixelRatio !== null ? parseFloat(res.devicePixelRatio!) : 1)\r\n this.items = [] as Item[];\r\n for (const key in res) {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n }\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"getWindowInfo":{"name":"## uni.getWindowInfo() @getwindowinfo","description":"同步获取窗口信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetWindowInfoResult](#getwindowinforesult-values) | \n\n#### GetWindowInfoResult 的属性值 @getwindowinforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| pixelRatio | number | 是 | - | 设备像素比 |\n| screenWidth | number | 是 | - | 屏幕宽度 |\n| screenHeight | number | 是 | - | 屏幕高度 |\n| windowWidth | number | 是 | - | 可使用窗口宽度 |\n| windowHeight | number | 是 | - | 可使用窗口高度 |\n| statusBarHeight | number | 是 | - | 状态栏的高度 |\n| windowTop | number | 是 | - | 可使用窗口的顶部位置 |\n| windowBottom | number | 是 | - | 可使用窗口的底部位置 |\n| safeArea | [SafeArea](#safearea-values) | 是 | - | 在竖屏正方向下的安全区域 |\n| safeAreaInsets | [SafeAreaInsets](#safeareainsets-values) | 是 | - | 在竖屏正方向下的安全区域插入位置 |\n| screenTop | number | 是 | - | 窗口上边缘的 y 值 |\n\n##### SafeArea 的属性值 @safearea-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左上角横坐标 |\n| right | number | 是 | - | 安全区域右下角横坐标 |\n| top | number | 是 | - | 安全区域左上角纵坐标 |\n| bottom | number | 是 | - | 安全区域右下角纵坐标 |\n| width | number | 是 | - | 安全区域的宽度,单位逻辑像素 |\n| height | number | 是 | - | 安全区域的高度,单位逻辑像素 |\n\n##### SafeAreaInsets 的属性值 @safeareainsets-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| left | number | 是 | - | 安全区域左侧插入位置 |\n| right | number | 是 | - | 安全区域右侧插入位置 |\n| top | number | 是 | - | 安全区顶部插入位置 |\n| bottom | number | 是 | - | 安全区域底部插入位置 |\n","compatibility":"### getWindowInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getWindowInfo](http://uniapp.dcloud.io/api/system/getWindowInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-window-info)\n"},"get-window-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-window-info/get-window-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-window-info/get-window-info\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n {{ item.label }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { setStatusBarHeight } from '@/store/index.uts'\r\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getWindowInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\n onReady() {\n this.getWindowInfo()\n },\r\n methods: {\r\n getWindowInfo: function () {\r\n const res = uni.getWindowInfo();\r\n // 获取状态栏+导航栏高度, 供截图对比使用\r\n setStatusBarHeight(res.statusBarHeight);\r\n this.items = [] as Item[];\r\n for (const key in res) {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n }\r\n },\r\n //自动化测试例专用\r\n jest_getWindowInfo() : GetWindowInfoResult {\r\n return uni.getWindowInfo();\r\n },\r\n }\r\n }\r\n\n```\n\n:::"},"getAppBaseInfo":{"name":"## uni.getAppBaseInfo(options?) @getappbaseinfo","description":"获取app基本信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetAppBaseInfoOptions](#getappbaseinfooptions-values) | 否 | 包含所有字段的过滤对象 | [options=包含所有字段的过滤对象\\] 过滤的字段对象, 不传参数默认为获取全部字段。 |\n#### GetAppBaseInfoOptions 的属性值 @getappbaseinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filter | Array\\ | 是 | - | 过滤字段的字符串数组,假如要获取指定字段,传入此数组。 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetAppBaseInfoResult](#getappbaseinforesult-values) | \n\n#### GetAppBaseInfoResult 的属性值 @getappbaseinforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| appId | string | 否 | - | manifest.json 中应用appid,即DCloud appid。\t |\n| appName | string | 否 | - | `manifest.json` 中应用名称。 |\n| appVersion | string | 否 | - | `manifest.json` 中应用版本名称。 |\n| appVersionCode | string | 否 | - | `manifest.json` 中应用版本名号。 |\n| appLanguage | string | 否 | - | 应用设置的语言en、zh-Hans、zh-Hant、fr、es\t |\n| language | string | 否 | - | 应用设置的语言\t |\n| ~~version~~ | string | 否 | - | 引擎版本号。已废弃,仅为了向下兼容保留 |\n| isUniAppX | boolean | 否 | - | 是否uni-app x |\n| ~~uniCompileVersion~~ | string | 否 | - | uni 编译器版本 |\n| uniCompilerVersion | string | 否 | - | uni 编译器版本 |\n| uniPlatform | \"app\" \\| \"web\" \\| \"mp-weixin\" \\| \"mp-alipay\" \\| \"mp-baidu\" \\| \"mp-toutiao\" \\| \"mp-lark\" \\| \"mp-qq\" \\| \"mp-kuaishou\" \\| \"mp-jd\" \\| \"mp-360\" \\| \"quickapp-webview\" \\| \"quickapp-webview-union\" \\| \"quickapp-webview-huawei\" | 否 | - | uni-app 运行平台。 |\n| uniRuntimeVersion | string | 否 | - | uni 运行时版本 |\n| ~~uniCompileVersionCode~~ | number | 否 | - | uni 编译器版本号 |\n| uniCompilerVersionCode | number | 否 | - | uni 编译器版本号 |\n| uniRuntimeVersionCode | number | 否 | - | uni 运行时版本号 |\n| packageName | string | 否 | - | Android的包名 |\n| signature | string | 否 | - | Android: 应用签名证书的SHA1值(全部为小写,中间不包含“:”)。 为了保证应用的安全性,请使用自己生成的证书(不要使用公共测试证书)。 iOS: 应用签名证书中绑定的Bundle ID(AppleID)的md5值(全部为小写)。 |\n\n##### GetAppBaseInfoResult 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| uniCompilerVersion | 4.0 | x | - |\n| uniCompilerVersionCode | 4.0 | x | - |\n| packageName | 3.97 | x | - |\n| signature | 3.97 | x | - |\n","compatibility":"### getAppBaseInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":"\n### 参见\n[getAppBaseInfo](https://uniapp.dcloud.net.cn/api/system/getAppBaseInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-app-base-info)\n"},"get-app-base-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app-base-info/get-app-base-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-app-base-info/get-app-base-info\n>Template\n```vue\n\r\n \r\n \r\n \n \n \n {{item.label}}\n \n \n \n \n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\n\ttype Item = {\n\t\tlabel : string,\n\t\tvalue : string,\n\t}\n\texport default {\r\n\t\tdata() {\r\n\t\t\treturn {\r\n\t\t\t\ttitle: 'getAppBaseInfo',\n\t\t\t\titems: [] as Item[],\r\n\t\t\t}\r\n\t\t},\r\n\t\tonUnload:function(){\r\n\t\t},\r\n\t\tmethods: {\r\n\t\t\tgetAppBaseInfo: function () {\n\t\t\t\tconst res = uni.getAppBaseInfo();\n this.items = [] as Item[];\n for(const key in res){\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n }\n\t\t\t}\r\n\t\t}\r\n\t}\r\n\n```\n\n:::"},"getAppAuthorizeSetting":{"name":"## uni.getAppAuthorizeSetting() @getappauthorizesetting","description":"获取 APP 授权设置。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetAppAuthorizeSettingResult](#getappauthorizesettingresult-values) | \n\n#### GetAppAuthorizeSettingResult 的属性值 @getappauthorizesettingresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| cameraAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | 允许 App 使用摄像头的开关
- authorized: 已经获得授权,无需再次请求授权
- denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
- not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
- config error: Android平台:表示没有授予 `android.permission.CAMERA` 权限;iOS平台没有该值 |\n| locationAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | 允许 App 使用定位的开关
- authorized: 已经获得授权,无需再次请求授权
- denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
- not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
- config error: Android平台:表示没有授予 `android.permission.ACCESS_COARSE_LOCATION` 权限;iOS平台:表示没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块 |\n| locationAccuracy | \"reduced\" \\| \"full\" \\| \"unsupported\" | 否 | - | 定位准确度。
- reduced: 模糊定位
- full: 精准定位
- unsupported: 不支持(包括用户拒绝定位权限和没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块) |\n| microphoneAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | 允许 App 使用麦克风的开关
- authorized: 已经获得授权,无需再次请求授权
- denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
- not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
- config error: Android平台:表示没有授予 `android.permission.RECORD_AUDIO` 权限;iOS平台没有该值 |\n| notificationAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | 允许 App 通知的开关
- authorized: 已经获得授权,无需再次请求授权
- denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
- not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
- config error: Android平台没有该值;iOS平台:表示没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 |\n","compatibility":"### getAppAuthorizeSetting 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","tutorial":"\n### 参见\n[getAppAuthorizeSetting](http://uniapp.dcloud.io/api/system/getappauthorizesetting)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-app-authorize-setting)\n"},"get-app-authorize-setting":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app-authorize-setting/get-app-authorize-setting.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n 是否授权使用摄像头\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 是否授权使用定位\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 定位准确度\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 是否授权使用麦克风\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 是否授权通知\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\n\n```"},"getSystemSetting":{"name":"## uni.getSystemSetting() @getsystemsetting","description":"获取系统设置","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetSystemSettingResult](#getsystemsettingresult-values) | \n\n#### GetSystemSettingResult 的属性值 @getsystemsettingresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| bluetoothEnabled | boolean | 否 | - | 蓝牙是否开启 |\n| bluetoothError | string | 否 | - | 蓝牙的报错信息 |\n| locationEnabled | boolean | 是 | - | 位置是否开启 |\n| wifiEnabled | boolean | 否 | - | wifi是否开启 |\n| wifiError | string | 否 | - | wifi的报错信息 |\n| deviceOrientation | \"portrait\" \\| \"landscape\" | 是 | - | 设备方向 |\n","compatibility":"### getSystemSetting 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","tutorial":"\n### 参见\n[getSystemSetting](https://uniapp.dcloud.net.cn/api/system/getsystemsetting.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-setting)\n"},"get-system-setting":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-system-setting/get-system-setting.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n 蓝牙的系统开关\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 地理位置的系统开关\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n Wi-Fi 的系统开关\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 设备方向\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\n\r\n\r\n\r\n\n\n```"},"installApk":{"name":"## uni.installApk(options) @installapk","description":"安装apk","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [InstallApkOptions](#installapkoptions-values) | 是 | - | - |\n#### InstallApkOptions 的属性值 @installapkoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string | 是 | - | apk文件地址 |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"","compatibility":"### installApk 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.94 | x | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.install-apk)\n"},"install-apk":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/install-apk/install-apk.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\n\n```"},"getPushClientId":{"name":"## uni.getPushClientId(options) @getpushclientid","description":"获取客户端唯一的推送标识","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetPushClientIdOptions](#getpushclientidoptions-values) | 是 | - | - |\n#### GetPushClientIdOptions 的属性值 @getpushclientidoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n","returnValue":"","compatibility":"### getPushClientId 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[getPushClientId](http://uniapp.dcloud.io/api/plugins/push.html#getpushclientid)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.getPushClientId)\n"},"onPushMessage":{"name":"## uni.onPushMessage(callback) @onpushmessage","description":"启动监听推送消息事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnPushMessageCallbackResult](#onpushmessagecallbackresult-values)) => void | 是 | - | - |\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | \"click\" \\| \"receive\" | 是 | - | 事件类型
- click 从系统推送服务点击消息启动应用事件
- receive 应用从推送服务器接收到推送消息事件 |\n| data | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | 消息内容 |\n","returnValue":"","compatibility":"### onPushMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[onPushMessage](http://uniapp.dcloud.io/api/plugins/push.html#onpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.onPushMessage)\n"},"offPushMessage":{"name":"## uni.offPushMessage(callback) @offpushmessage","description":"关闭推送消息监听事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [OnPushMessageCallbackResult](#onpushmessagecallbackresult-values)) => void | 是 | - | - |\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | \"click\" \\| \"receive\" | 是 | - | 事件类型
- click 从系统推送服务点击消息启动应用事件
- receive 应用从推送服务器接收到推送消息事件 |\n| data | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | 消息内容 |\n","returnValue":"","compatibility":"### offPushMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[offPushMessage](http://uniapp.dcloud.io/api/plugins/push.html#offpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.offPushMessage)\n"},"getChannelManager":{"name":"## uni.getChannelManager() @getchannelmanager","description":"获取通知渠道管理器,Android 8系统以上才可以设置通知渠道,Android 8系统以下返回null。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [ChannelManager](#channelmanager-values) | \n\n#### ChannelManager 的方法 @channelmanager-values \n\n#### setPushChannel(options) @setpushchannel\n\n设置推送渠道\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetPushChannelOptions](#setpushchanneloptions-values) | 是 | - | - |\n###### SetPushChannelOptions 的属性值 @setpushchanneloptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| soundName | string \\| null | 否 | null | |\n| channelId | string | 是 | - | 通知渠道id |\n| channelDesc | string | 是 | - | 通知渠道描述 |\n| enableLights | boolean \\| null | 否 | false | |\n| enableVibration | boolean \\| null | 否 | false | |\n| importance | number \\| null | 否 | 3 | |\n| lockscreenVisibility | number \\| null | 否 | -1000 | |\n\n\n##### setPushChannel 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n\n\n#### getAllChannels() @getallchannels\n\n获取当前应用注册的所有的通知渠道。\n\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\ | \n\n##### getAllChannels 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n\n","compatibility":"### getChannelManager 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.getChannelManager)\n"},"createPushMessage":{"name":"## uni.createPushMessage(options) @createpushmessage","description":"创建本地通知栏消息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [CreatePushMessageOptions](#createpushmessageoptions-values) | 是 | - | - |\n#### CreatePushMessageOptions 的属性值 @createpushmessageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| cover | boolean \\| null | 否 | false | |\n| delay | number \\| null | 否 | 0 | |\n| icon | string \\| null | 否 | null | |\n| sound | string \\| null | 否 | \"system\" | |\n| title | string \\| null | 否 | App的名称 | |\n| content | string | 是 | - | 消息显示的内容,在系统通知中心中显示的文本内容 |\n| payload | any \\| null | 否 | null | |\n| when | number \\| null | 否 | 当前时间 | |\n| channelId | string \\| null | 否 | \"DcloudChannelID\" | |\n| category | string \\| null | 否 | null | |\n| success | Function \\| null | 否 | null | |\n| fail | Function \\| null | 否 | null | |\n| complete | Function \\| null | 否 | null | |\n\n##### CreatePushMessageOptions 兼容性 \n| | Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- | :- |\n| channelId | 4.4 | 3.98 | x | - |\n| category | 4.4 | 3.98 | x | - |\n","returnValue":"","compatibility":"### createPushMessage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.98 | x | - |\n","tutorial":"\n### 参见\n[createPushMessage](http://uniapp.dcloud.io/api/plugins/push.html#createpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.createPushMessage)\n"},"getBatteryInfo":{"name":"## uni.getBatteryInfo(options) @getbatteryinfo","description":"获取电池电量信息\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetBatteryInfoOptions](#getbatteryinfooptions-values) | 是 | - | - |\n#### GetBatteryInfoOptions 的属性值 @getbatteryinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (res: [GetBatteryInfoSuccess](#getbatteryinfosuccess-values)) => void | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |\n| fail | (res: UniError) => void | 否 | - | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | - | 接口调用成功的回调 |\n\n##### GetBatteryInfoSuccess 的属性值 @getbatteryinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | - |\n| level | number | 是 | - | 设备电量,范围1 - 100 |\n| isCharging | boolean | 是 | - | 是否正在充电中 |\n","returnValue":"","compatibility":"### getBatteryInfo 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-battery-info.getBatteryInfo)\n"},"getBatteryInfoSync":{"name":"## uni.getBatteryInfoSync() @getbatteryinfosync","description":"获取电池电量信息\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetBatteryInfoResult](#getbatteryinforesult-values) | \n\n#### GetBatteryInfoResult 的属性值 @getbatteryinforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| level | number | 是 | - | 设备电量,范围1 - 100 |\n| isCharging | boolean | 是 | - | 是否正在充电中 |\n","compatibility":"### getBatteryInfoSync 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-battery-info.getBatteryInfoSync)\n"},"get-battery-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-battery-info/get-battery-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-battery-info/get-battery-info\n>Template\n```vue\n\r\n\t\r\n\t\t当前电量:{{level}}%\r\n\t\t是否充电中:{{isCharging}}\r\n\t\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n\texport default {\r\n\t\tdata() {\r\n\t\t\treturn {\r\n\t\t\t\tlevel: 0,\r\n\t\t\t\tisCharging: false\r\n\t\t\t}\r\n\t\t},\r\n\t\tonLoad() {\r\n\t\t\tuni.getBatteryInfo({\r\n\t\t\t\tsuccess: res => {\r\n\t\t\t\t\tthis.level = res.level;\r\n\t\t\t\t\tthis.isCharging = res.isCharging;\r\n\t\t\t\t}\r\n\t\t\t});\r\n\t\t}\r\n\t}\r\n\n```\n\n:::"},"startWifi":{"name":"## uni.startWifi(option) @startwifi","description":"\r\n初始化Wi-Fi模块\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | Wifi 函数通用入参封装 |\n#### WifiOption 的属性值 @wifioption-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - |\n| fail | (res: UniError) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | interface \\| null | 否 | - | |\n","returnValue":"","compatibility":"### startWifi 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[startWifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#startwifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.startWifi)\n"},"connectWifi":{"name":"## uni.connectWifi(option) @connectwifi","description":"","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [WifiConnectOption](#wificonnectoption-values) | 是 | - | Wifi 链接参数封装 |\n#### WifiConnectOption 的属性值 @wificonnectoption-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SSID | string | 否 | - | - |\n| BSSID | string | 否 | - | - |\n| password | string | 否 | - | - |\n| maunal | boolean | 否 | - | - |\n| partialInfo | boolean | 否 | - | - |\n| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - |\n| fail | (res: UniError) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | interface \\| null | 否 | - | |\n","returnValue":"","compatibility":"### connectWifi 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| >=4.4 && <10.0 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[connectWifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#connectWifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.connectWifi)\n"},"getWifiList":{"name":"## uni.getWifiList(option) @getwifilist","description":"\r\n请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | Wifi 函数通用入参封装 |\n#### WifiOption 的属性值 @wifioption-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - |\n| fail | (res: UniError) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | interface \\| null | 否 | - | |\n","returnValue":"","compatibility":"### getWifiList 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[getWifiList](https://uniapp.dcloud.net.cn/api/system/wifi.html#getWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.getWifiList)\n"},"onGetWifiList":{"name":"## uni.onGetWifiList(callback) @ongetwifilist","description":"\r\n监听获取到 Wi-Fi 列表数据事件。\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (wifiInfo: any) => void | 是 | - | - |","returnValue":"","compatibility":"### onGetWifiList 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[onGetWifiList](https://uniapp.dcloud.net.cn/api/system/wifi.html#onGetWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onGetWifiList)\n"},"offGetWifiList":{"name":"## uni.offGetWifiList(callback) @offgetwifilist","description":"\r\n移除获取到 Wi-Fi 列表数据事件的监听函数。\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | () => void | 是 | - | - |","returnValue":"","compatibility":"### offGetWifiList 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[offGetWifiList](https://uniapp.dcloud.net.cn/api/system/wifi.html#offGetWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.offGetWifiList)\n"},"getConnectedWifi":{"name":"## uni.getConnectedWifi(option) @getconnectedwifi","description":"\r\n获取已连接的 Wi-Fi 信息\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [GetConnectedWifiOptions](#getconnectedwifioptions-values) | 是 | - | 获取当前链接的wifi信息 |\n#### GetConnectedWifiOptions 的属性值 @getconnectedwifioptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| partialInfo | boolean | 否 | - | - |\n| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - |\n| fail | (res: UniError) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | interface \\| null | 否 | - | |\n","returnValue":"","compatibility":"### getConnectedWifi 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[getConnectedWifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#getConnectedWifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.getConnectedWifi)\n"},"onWifiConnected":{"name":"## uni.onWifiConnected(callback) @onwificonnected","description":"\r\n监听连接上 Wi-Fi 的事件\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (wifiInfo: [UniWifiResult](#uniwifiresult-values)) => void | 是 | - | - |\n#### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | - |\n| errSubject | string | 是 | - | - |\n| errMsg | string | 是 | - | - |\n| wifi | interface \\| null | 否 | - | |\n","returnValue":"","compatibility":"### onWifiConnected 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[onWifiConnected](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnected)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onWifiConnected)\n"},"onWifiConnectedWithPartialInfo":{"name":"## uni.onWifiConnectedWithPartialInfo(callback) @onwificonnectedwithpartialinfo","description":"\r\n监听连接上 Wi-Fi 的事件。\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (wifiInfo: [UniWifiInfoWithPartialInfo](#uniwifiinfowithpartialinfo-values)) => void | 是 | - | - |\n#### UniWifiInfoWithPartialInfo 的属性值 @uniwifiinfowithpartialinfo-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| SSID | string | 是 | - | - |\n","returnValue":"","compatibility":"### onWifiConnectedWithPartialInfo 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[onWifiConnectedWithPartialInfo](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnectedWithPartialInfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onWifiConnectedWithPartialInfo)\n"},"offWifiConnected":{"name":"## uni.offWifiConnected(callback?) @offwificonnected","description":"\r\n移除连接上 Wi-Fi 的事件的监听函数。\r\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | Function \\| null | 否 | - | |","returnValue":"","compatibility":"### offWifiConnected 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[offWifiConnected](https://uniapp.dcloud.net.cn/api/system/wifi.html#offWifiConnected)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.offWifiConnected)\n"},"onMemoryWarning":{"name":"## uni.onMemoryWarning(callback) @onmemorywarning","description":"\n开启监听内存警告\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-memorywarning](https://ext.dcloud.net.cn/plugin?name=uni-memorywarning)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (res: [MemoryWarningCallbackResult](#memorywarningcallbackresult-values)) => void | 是 | - | uni.onMemoryWarning/uni.offMemoryWarning回调函数定义 |\n#### MemoryWarningCallbackResult 的属性值 @memorywarningcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| level | number | 是 | - | 内存警告等级(仅安卓平台有效,iOS始终是0) |\n","returnValue":"","compatibility":"### onMemoryWarning 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[onMemoryWarning](https://uniapp.dcloud.net.cn/api/system/memory.html#onmemorywarning)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.memory.onMemoryWarning)\n"},"offMemoryWarning":{"name":"## uni.offMemoryWarning(callback?) @offmemorywarning","description":"\n取消监听内存不足告警事件\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-memorywarning](https://ext.dcloud.net.cn/plugin?name=uni-memorywarning)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | Function \\| null | 否 | - | |","returnValue":"","compatibility":"### offMemoryWarning 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | x | - |\n","tutorial":"\n### 参见\n[offMemoryWarning](https://uniapp.dcloud.net.cn/api/system/memory.html#offmemorywarning)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.memory.offMemoryWarning)\n"},"onUserCaptureScreen":{"name":"## uni.onUserCaptureScreen(callback?) @onusercapturescreen","description":"\n开启截屏监听 \n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | Function \\| null | 否 | - | uni.onUserCaptureScreen/uni.offUserCaptureScreen回调函数定义 |","returnValue":"","compatibility":"### onUserCaptureScreen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | 3.9.0 | - |\n","tutorial":"\n### 参见\n[onUserCaptureScreen](https://uniapp.dcloud.net.cn/api/system/capture-screen.html#onusercapturescreen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.captureScreen.onUserCaptureScreen)\n"},"offUserCaptureScreen":{"name":"## uni.offUserCaptureScreen(callback?) @offusercapturescreen","description":"\n关闭截屏监听 \n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | Function \\| null | 否 | - | |","returnValue":"","compatibility":"### offUserCaptureScreen 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4.4 | 3.9.0 | 3.9.0 | - |\n","tutorial":"\n### 参见\n[offUserCaptureScreen](https://uniapp.dcloud.net.cn/api/system/capture-screen.html#offusercapturescreen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.captureScreen.offUserCaptureScreen)\n"},"createRequestPermissionListener":{"name":"## uni.createRequestPermissionListener() @createrequestpermissionlistener","description":"创建一个监听权限申请的对象。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RequestPermissionListener](#requestpermissionlistener-values) | \n\n#### RequestPermissionListener 的方法 @requestpermissionlistener-values \n\n#### onRequest(callback) @onrequest\n\r\n监听申请系统权限\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (permissions: Array\\) => void | 是 | - | ,申请系统权限回调,permissions为触发权限申请的所有权限 |\n\n\n\n#### onConfirm(callback) @onconfirm\n\r\n监听弹出系统权限授权框\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (permissions: Array\\) => void | 是 | - | ,弹出系统权限授权框回调,permissions为触发权限授权框的所有权限 |\n\n\n\n#### onComplete(callback) @oncomplete\n\r\n监听权限申请完成\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (permissions: Array\\) => void | 是 | - | ,权限申请完成回调,permissions为申请完成的所有权限 |\n\n\n\n#### stop() @stop\n\r\n取消所有监听\n\n\n\n","compatibility":"### createRequestPermissionListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | - | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.createRequestPermissionListener)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/create-request-permission-listener/create-request-permission-listener.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n 访问日历权限申请说明:\r\n uni-app x正在申请访问日历权限用于演示,允许或拒绝均不会获取任何隐私信息。\r\n \r\n \r\n\r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"chooseImage":{"name":"## uni.chooseImage(options) @chooseimage","description":"从本地相册选择图片或使用相机拍照","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ChooseImageOptions](#chooseimageoptions-values) | 是 | - | - |\n#### ChooseImageOptions 的属性值 @chooseimageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| count | number \\| null | 否 | 9 | |\n| sizeType | Array \\| null | 否 | ['original','compressed'\\] | |\n| sourceType | Array \\| null | 否 | ['album','camera'\\] | |\n| crop | interface \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n","returnValue":"","compatibility":"### chooseImage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | - | 4.0 |\n","tutorial":"\n### 参见\n[chooseImage](http://uniapp.dcloud.io/api/media/image?id=chooseimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.choose-image)\n"},"choose-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/choose-image/choose-image.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/choose-image/choose-image\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 图片来源\r\n \r\n \r\n {{sourceType[sourceTypeIndex]}}\r\n \r\n \r\n\r\n \r\n \r\n 图片质量\r\n \r\n \r\n {{sizeType[sizeTypeIndex]}}\r\n \r\n \r\n\r\n \r\n \r\n 数量限制\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 图像裁剪\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 图片质量(%)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 裁剪宽度(px)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 裁剪高度(px)\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 保留原宽高\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n 点击可预览选好的图片\r\n \r\n {{imageList.length}}/{{countIndex+1}}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n var sourceTypeArray = [\r\n ['camera'],\r\n ['album'],\r\n ['camera', 'album']\r\n ]\r\n var sizeTypeArray = [\r\n ['compressed'],\r\n ['original'],\r\n ['compressed', 'original']\r\n ]\r\n export default {\r\n data() {\r\n return {\r\n title: 'choose/previewImage',\r\n imageList: [] as Array,\r\n sourceTypeIndex: 2,\r\n sourceType: ['拍照', '相册', '拍照或相册'],\r\n sizeTypeIndex: 2,\r\n sizeType: ['压缩', '原图', '压缩或原图'],\r\n countIndex: 8,\r\n count: [1, 2, 3, 4, 5, 6, 7, 8, 9],\r\n isCrop: false,\r\n cropPercent: 80,\r\n cropWidth: 100,\r\n cropHeight: 100,\r\n cropResize: false\r\n }\r\n },\r\n onUnload() {\r\n this.imageList = [];\r\n this.sourceTypeIndex = 2\r\n this.sourceType = ['拍照', '相册', '拍照或相册']\r\n this.sizeTypeIndex = 2\r\n this.sizeType = ['压缩', '原图', '压缩或原图']\r\n this.countIndex = 8\r\n },\r\n methods: {\r\n cropHeightConfim(e : InputConfirmEvent) {\r\n let value = parseInt(e.detail.value)\r\n if (value > 0) {\r\n this.cropHeight = value\r\n } else {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"裁剪高度需要大于0\"\r\n })\r\n }\r\n },\r\n cropWidthConfim(e : InputConfirmEvent) {\r\n let value = parseInt(e.detail.value)\r\n if (value > 0) {\r\n this.cropWidth = value\r\n } else {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"裁剪宽度需要大于0\"\r\n })\r\n }\r\n },\r\n cropPercentConfim(e : InputConfirmEvent) {\r\n let value = parseInt(e.detail.value)\r\n if (value > 0 && value <= 100) {\r\n this.cropPercent = value\r\n } else {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"请输入0~100之间的值\"\r\n })\r\n }\r\n },\r\n cropResizeChange(e : UniSwitchChangeEvent) {\r\n this.cropResize = e.detail.value\r\n },\r\n switchCrop(e : UniSwitchChangeEvent) {\r\n this.isCrop = e.detail.value\r\n },\r\n removeImage(index : number) {\r\n this.imageList.splice(index, 1)\r\n },\r\n chooseImageSource() {\r\n uni.showActionSheet({\r\n itemList: ['拍照', '相册', '拍照或相册'],\r\n success: (e) => {\r\n this.sourceTypeIndex = e.tapIndex!\r\n }\r\n })\r\n },\r\n chooseImageType() {\r\n uni.showActionSheet({\r\n itemList: ['压缩', '原图', '压缩或原图'],\r\n success: (e) => {\r\n this.sizeTypeIndex = e.tapIndex!\r\n }\r\n })\r\n },\r\n chooseImageCount(event : InputConfirmEvent) {\r\n let count = parseInt(event.detail.value) - 1\r\n if (count < 0) {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"图片数量应该大于0\"\r\n })\r\n return\r\n }\r\n this.countIndex = count\r\n },\r\n chooseImage: function () {\r\n // var cropOption:ChooseImageCropOptions|null = this.isCrop ? null : new ChooseImageCropOptions( )\r\n if (this.imageList.length >= 9) {\r\n uni.showToast({\r\n position: \"bottom\",\r\n title: \"已经有9张图片了,请删除部分图片之后重新选择\"\r\n })\r\n return\r\n }\r\n uni.chooseImage({\r\n sourceType: sourceTypeArray[this.sourceTypeIndex],\r\n sizeType: sizeTypeArray[this.sizeTypeIndex],\r\n crop: this.isCrop ? { \"quality\": this.cropPercent, \"width\": this.cropWidth, \"height\": this.cropHeight, \"resize\": this.cropResize } as ChooseImageCropOptions : null,\r\n count: this.imageList.length + this.count[this.countIndex] > 9 ? 9 - this.imageList.length : this.count[this.countIndex],\r\n success: (res) => {\r\n this.imageList = this.imageList.concat(res.tempFilePaths);\r\n },\r\n fail: (err) => {\r\n console.log(\"err: \", JSON.stringify(err));\r\n }\r\n })\r\n },\r\n previewImage: function (index : number) {\r\n uni.previewImage({\r\n current: index,\r\n urls: this.imageList\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"previewImage":{"name":"## uni.previewImage(options) @previewimage","description":"预览图片","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [PreviewImageOptions](#previewimageoptions-values) | 是 | - | - |\n#### PreviewImageOptions 的属性值 @previewimageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| current | any \\| null | 否 | - | |\n| urls | Array\\ | 是 | - | 需要预览的图片链接列表 |\n| indicator | string \\| null | 否 | - | |\n| loop | boolean \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n","returnValue":"","compatibility":"### previewImage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | - | 4.0 |\n","tutorial":"\n### 参见\n[previewImage](http://uniapp.dcloud.io/api/media/image?id=previewimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.preview-image.previewImage)\n"},"closePreviewImage":{"name":"## uni.closePreviewImage(options) @closepreviewimage","description":"关闭图片预览","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ClosePreviewImageOptions](#closepreviewimageoptions-values) | 是 | - | - |\n#### ClosePreviewImageOptions 的属性值 @closepreviewimageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n","returnValue":"","compatibility":"### closePreviewImage 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | - | - |\n","tutorial":"\n### 参见\n[closePreviewImage](http://uniapp.dcloud.io/api/media/image?id=closepreviewimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.preview-image.closePreviewImage)\n"},"preview-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/preview-image/preview-image.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/preview-image/preview-image\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n 图片指示器样式\r\n \r\n \r\n {{\r\n item.name\r\n }}\r\n \r\n \r\n \r\n \r\n \r\n 循环播放\r\n \r\n \r\n \r\n 点击图片开始预览\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n imageList: [\"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni@2x.png\", \"/static/uni.png\"],\r\n indicator: [{\r\n value: \"default\",\r\n name: \"圆点\"\r\n }, {\r\n value: \"number\",\r\n name: \"数字\"\r\n }, {\r\n value: \"none\",\r\n name: \"不显示\"\r\n }] as ItemType[],\r\n currentIndicator: \"default\",\r\n isLoop: true\r\n }\r\n },\r\n methods: {\r\n previewImage(index : number) {\r\n uni.previewImage({\r\n urls: this.imageList,\r\n current: index,\r\n indicator: this.currentIndicator,\r\n loop: this.isLoop\r\n })\r\n },\r\n chooseImage() {\r\n uni.chooseImage({\r\n sourceType: ['album'],\r\n success: (e) => {\r\n this.imageList = this.imageList.concat(e.tempFilePaths)\r\n },\r\n fail(_) {\r\n }\r\n })\r\n },\r\n onIndicatorChanged(e : UniRadioGroupChangeEvent) {\r\n this.currentIndicator = e.detail.value\r\n },\r\n onCheckboxChange(_ : UniCheckboxGroupChangeEvent) {\r\n this.isLoop = !this.isLoop\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"saveImageToPhotosAlbum":{"name":"## uni.saveImageToPhotosAlbum(options) @saveimagetophotosalbum","description":"保存图片到系统相册","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SaveImageToPhotosAlbumOptions](#saveimagetophotosalbumoptions-values) | 是 | - | - |\n#### SaveImageToPhotosAlbumOptions 的属性值 @saveimagetophotosalbumoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string.ImageURIString | 是 | - | 图片文件路径,可以是临时文件路径也可以是永久文件路径,不支持网络图片路径 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n","returnValue":"","compatibility":"### saveImageToPhotosAlbum 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | - | - |\n","tutorial":"\n### 参见\n[saveImageToPhotosAlbum](http://uniapp.dcloud.io/api/media/image?id=saveimagetophotosalbum)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.save-image-to-photos-album)\n"},"save-image-to-photos-album":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/save-image-to-photos-album/save-image-to-photos-album.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"getLocation":{"name":"## uni.getLocation(options) @getlocation","description":"获取当前的地理位置、速度","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetLocationOptions](#getlocationoptions-values) | 是 | - | - |\n#### GetLocationOptions 的属性值 @getlocationoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string \\| null | 否 | wgs84 | |\n| altitude | boolean \\| null | 否 | false | |\n| geocode | boolean \\| null | 否 | false | |\n| highAccuracyExpireTime | number \\| null | 否 | 3000 | |\n| isHighAccuracy | boolean \\| null | 否 | false | |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n","returnValue":"","compatibility":"### getLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | x | 4.0 |\n","tutorial":"\n### 参见\n[getLocation]([](http://uniapp.dcloud.io/api/location/location?id=getlocation))\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.location.get-location)\n"},"get-location":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-location/get-location.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-location/get-location\n>Template\n```vue\n\r\n \r\n \r\n \r\n 定位功能默认调用操作系统定位API实现。\\n\r\n 部分手机因gms兼容不好可能导致无法定位。\\n\r\n gcj国标、逆地理信息等功能需三方sdk定位。如果需要类似能力可以下载腾讯定位插件,打包自定义基座。参考示例:\r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n {{item.name}}\r\n \r\n \r\n \r\n \r\n 高度信息\r\n \r\n \r\n \r\n 开启高精度定位\r\n \r\n \r\n \r\n 是否解析地址信息\r\n \r\n \r\n {{exeRet}}\r\n \r\n \r\n \r\n \r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'get-location',\r\n altitudeSelect: false,\r\n isHighAccuracySelect: false,\r\n geocodeSelect: false,\r\n exeRet: '',\r\n items: [\r\n {\r\n value: 'wgs84',\r\n name: 'wgs84'\r\n },\r\n {\r\n value: 'gcj02',\r\n name: 'gcj02'\r\n }\r\n ] as ItemType[],\r\n current: 0,\r\n }\r\n },\r\n methods: {\r\n altitudeChange: function (e : UniSwitchChangeEvent) {\r\n this.altitudeSelect = e.detail.value\r\n },\r\n geocodeChange: function (e : UniSwitchChangeEvent) {\r\n this.geocodeSelect = e.detail.value\r\n },\r\n highAccuracySelectChange: function (e : UniSwitchChangeEvent) {\r\n this.isHighAccuracySelect = e.detail.value\r\n },\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n for (let i = 0; i < this.items.length; i++) {\r\n if (this.items[i].value === e.detail.value) {\r\n this.current = i;\r\n break;\r\n }\r\n }\r\n },\r\n getLocationTap: function () {\r\n uni.showLoading({\r\n title: '定位中'\r\n })\r\n uni.getLocation(({\r\n type: this.items[this.current].value,\r\n altitude: this.altitudeSelect,\r\n isHighAccuracy: this.isHighAccuracySelect,\r\n geocode: this.geocodeSelect,\r\n success: (res : any) => {\r\n uni.hideLoading()\r\n console.log(res);\r\n this.exeRet = JSON.stringify(res)\r\n },\r\n fail: (res : any) => {\r\n uni.hideLoading()\r\n console.log(res);\r\n this.exeRet = JSON.stringify(res)\r\n },\r\n complete: (res : any) => {\r\n uni.hideLoading()\r\n console.log(res);\r\n this.exeRet = JSON.stringify(res)\r\n }\r\n }));\r\n\r\n\r\n }\r\n\r\n }\r\n }\r\n\n```\n\n:::"},"getStorageInfo":{"name":"## uni.getStorageInfo(options) @getstorageinfo","description":"\r\nuni.getStorageInfo函数定义\r\n异步获取当前 storage 的相关信息。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetStorageInfoOptions](#getstorageinfooptions-values) | 是 | - | uni.getStorageInfo参数定义 |\n#### GetStorageInfoOptions 的属性值 @getstorageinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | Function \\| null | 否 | - | uni.getStorageInfo成功回调函数定义 |\n| fail | Function \\| null | 否 | - | uni.getStorageInfo失败回调函数定义 |\n| complete | Function \\| null | 否 | - | uni.getStorageInfo完成回调函数定义 |\n","returnValue":"","compatibility":"### getStorageInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[getStorageInfo](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageInfo)\n"},"getStorageInfoSync":{"name":"## uni.getStorageInfoSync() @getstorageinfosync","description":"\r\nuni.getStorageInfoSync函数定义\r\n同步获取当前 storage 的相关信息。\r\n\r\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetStorageInfoSuccess](#getstorageinfosuccess-values) | \n\n#### GetStorageInfoSuccess 的属性值 @getstorageinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| keys | Array\\ | 是 | - | 当前 storage 中所有的 key |\n| currentSize | number | 是 | - | 当前占用的空间大小, 单位:kb |\n| limitSize | number | 是 | - | 限制的空间大小, 单位:kb |\n","compatibility":"### getStorageInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[getStorageInfoSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfosync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageInfoSync)\n"},"getStorage":{"name":"## uni.getStorage(options) @getstorage","description":"\r\nuni.getStorage函数定义\r\n从本地存储中异步获取指定 key 对应的内容。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetStorageOptions](#getstorageoptions-values) | 是 | - | uni.getStorage参数定义 |\n#### GetStorageOptions 的属性值 @getstorageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |\n| success | Function \\| null | 否 | - | uni.getStorage成功回调函数定义 |\n| fail | Function \\| null | 否 | - | uni.getStorage失败回调函数定义 |\n| complete | Function \\| null | 否 | - | uni.getStorage完成回调函数定义 |\n","returnValue":"","compatibility":"### getStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[getStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorage)\n"},"getStorageSync":{"name":"## uni.getStorageSync(key) @getstoragesync","description":"\r\nuni.getStorageSync函数定义\r\n从本地存储中同步获取指定 key 对应的内容。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 | \n","compatibility":"### getStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[getStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageSync)\n"},"setStorage":{"name":"## uni.setStorage(options) @setstorage","description":"\r\nuni.setStorage函数定义\r\n将数据存储在本地storage存储中指定的 key 中,会覆盖掉原来该 key 对应的内容,这是一个异步接口。 \r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [SetStorageOptions](#setstorageoptions-values) | 是 | - | uni.setStorage参数定义 |\n#### SetStorageOptions 的属性值 @setstorageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |\n| data | any | 是 | - | 需要存储的内容,只支持原生类型、及能够通过 JSON.stringify 序列化的对象 |\n| success | Function \\| null | 否 | - | uni.setStorage成功回调函数定义 |\n| fail | Function \\| null | 否 | - | uni.setStorage失败回调函数定义 |\n| complete | Function \\| null | 否 | - | uni.setStorage完成回调函数定义 |\n","returnValue":"","compatibility":"### setStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[setStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.setStorage)\n"},"setStorageSync":{"name":"## uni.setStorageSync(key, data) @setstoragesync","description":"\r\nuni.setStorageSync函数定义\r\n将 data 存储在本地storage存储中指定的 key 中,会覆盖掉原来该 key 对应的内容,这是一个同步接口。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地storage存储中的指定的 key |\n| data | any | 是 | - | 需要存储的内容,只支持原生类型、及能够通过 JSON.stringify 序列化的对象 |","returnValue":"","compatibility":"### setStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[setStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.setStorageSync)\n"},"removeStorage":{"name":"## uni.removeStorage(options) @removestorage","description":"\r\nuni.removeStorage函数定义\r\n从本地存储中异步移除指定 key。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RemoveStorageOptions](#removestorageoptions-values) | 是 | - | uni.removeStorage参数定义 |\n#### RemoveStorageOptions 的属性值 @removestorageoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |\n| success | Function \\| null | 否 | - | uni.removeStorage成功回调函数定义 |\n| fail | Function \\| null | 否 | - | uni.removeStorage失败回调函数定义 |\n| complete | Function \\| null | 否 | - | uni.removeStorage完成回调函数定义 |\n","returnValue":"","compatibility":"### removeStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[removeStorage](hhttps://uniapp.dcloud.net.cn/api/storage/storage.html#removestorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.removeStorage)\n"},"removeStorageSync":{"name":"## uni.removeStorageSync(key) @removestoragesync","description":"\r\nuni.removeStorageSync函数定义\r\n从本地存储中同步移除指定 key。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| key | string | 是 | - | 本地存储中的指定的 key |","returnValue":"","compatibility":"### removeStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[removeStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#removestoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.removeStorageSync)\n"},"clearStorage":{"name":"## uni.clearStorage(option?) @clearstorage","description":"\r\nuni.clearStorage函数定义\r\n清除本地数据存储。\r\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | interface \\| null | 否 | - | uni.removeStorage参数定义 |","returnValue":"","compatibility":"### clearStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[clearStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.clearStorage)\n"},"clearStorageSync":{"name":"## uni.clearStorageSync() @clearstoragesync","description":"\r\nuni.clearStorageSync函数定义\r\n清除本地数据存储。\r\n","param":"","returnValue":"","compatibility":"### clearStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 3.9.0 | 4.0 |\n","tutorial":"\n### 参见\n[clearStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.clearStorageSync)\n"},"storage":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/storage/storage.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/storage/storage\n>Template\n```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n key\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n value\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n {{ storageInfo }}\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'get/set/clearStorage',\r\n key: '',\r\n data: '' as any,\r\n apiGetData: '' as any | null,\r\n storageInfo: '',\r\n }\r\n },\r\n methods: {\r\n getStorageInfo() {\r\n uni.getStorageInfo({\r\n success: (res) => {\r\n this.apiGetData = res\r\n this.storageInfo = JSON.stringify(res)\r\n },\r\n })\r\n },\r\n getStorageInfoSync() {\r\n try {\r\n const res = uni.getStorageInfoSync()\r\n this.apiGetData = res\r\n this.storageInfo = JSON.stringify(res)\r\n } catch (e) {\r\n // error\r\n console.log(e)\r\n }\r\n },\r\n jsonLikeMock() {\r\n this.key = 'key_' + Math.random()\r\n this.data = JSON.stringify({\r\n name: \"james\",\r\n age: 12,\r\n from: \"american\"\r\n });\r\n },\r\n strMock() {\r\n this.key = 'key_' + Math.random()\r\n this.data = '测试字符串数据,长度为16个字符'\r\n },\r\n complexMock() {\r\n this.key = 'key_' + Math.random()\r\n let jsonObj = {\r\n name: '张三',\r\n age: 12,\r\n classMate: [\r\n {\r\n id: 1001,\r\n name: '李四',\r\n },\r\n {\r\n id: 1002,\r\n name: 'jack ma',\r\n },\r\n ],\r\n }\r\n this.data = jsonObj\r\n },\r\n numberMock() {\r\n this.key = 'key_' + Math.random()\r\n this.data = 10011\r\n },\r\n floatMock() {\r\n this.key = 'key_' + Math.random()\r\n this.data = 3.1415926535893384626\r\n },\r\n\r\n keyChange: function (e : InputEvent) {\r\n this.key = e.detail.value\r\n },\r\n dataChange: function (e : InputEvent) {\r\n this.data = e.detail.value\r\n },\r\n getStorage: function () {\r\n var key = this.key\r\n if (key.length == 0) {\r\n uni.showModal({\r\n title: '读取数据失败',\r\n content: 'key 不能为空',\r\n showCancel: false,\r\n })\r\n } else {\r\n let that = this\r\n uni.getStorage({\r\n key: key,\r\n success: (res) => {\r\n\r\n that.apiGetData = res.data\r\n let desc : string = typeof this.apiGetData\r\n if (\"object\" == desc) {\r\n desc = desc + \": \" + JSON.stringify(this.apiGetData)\r\n } else {\r\n desc = desc + \": \" + this.apiGetData\r\n }\r\n\r\n uni.showModal({\r\n title: '读取数据成功',\r\n content: desc,\r\n showCancel: false,\r\n })\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n title: '读取数据失败',\r\n content: '找不到 key 对应的数据',\r\n showCancel: false,\r\n })\r\n },\r\n })\r\n }\r\n },\r\n getStorageSync: function () {\r\n var key = this.key\r\n if (key.length == 0) {\r\n uni.showModal({\r\n title: '读取数据失败',\r\n content: 'key 不能为空',\r\n showCancel: false,\r\n })\r\n } else {\r\n this.apiGetData = uni.getStorageSync(key)\r\n\r\n let desc : string = typeof this.apiGetData\r\n if (\"object\" == desc) {\r\n desc = desc + \": \" + JSON.stringify(this.apiGetData)\r\n } else {\r\n desc = desc + \": \" + this.apiGetData\r\n }\r\n\r\n uni.showModal({\r\n title: '读取数据成功',\r\n content: desc,\r\n showCancel: false,\r\n })\r\n }\r\n },\r\n setStorage: function () {\r\n var key = this.key\r\n var data = this.data\r\n if (key.length == 0) {\r\n uni.showModal({\r\n title: '保存数据失败',\r\n content: 'key 不能为空',\r\n showCancel: false,\r\n })\r\n } else {\r\n uni.setStorage({\r\n key: key,\r\n data: data,\r\n success: () => {\r\n uni.showModal({\r\n title: '存储数据成功',\r\n showCancel: false,\r\n })\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n title: '储存数据失败!',\r\n showCancel: false,\r\n })\r\n },\r\n })\r\n }\r\n },\r\n setStorageSync: function () {\r\n var key = this.key\r\n var data = this.data\r\n if (key.length == 0) {\r\n uni.showModal({\r\n title: '保存数据失败',\r\n content: 'key 不能为空',\r\n showCancel: false,\r\n })\r\n } else {\r\n uni.setStorageSync(key, data)\r\n uni.showModal({\r\n title: '存储数据成功',\r\n showCancel: false,\r\n })\r\n }\r\n },\r\n removeStorage: function () {\r\n uni.removeStorage({\r\n key: this.key,\r\n success: () => {\r\n uni.showModal({\r\n title: '移除数据成功',\r\n showCancel: false,\r\n })\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n title: '移除数据失败',\r\n showCancel: false,\r\n })\r\n },\r\n })\r\n },\r\n removeStorageSync: function () {\r\n uni.removeStorageSync(this.key)\r\n uni.showModal({\r\n title: '移除数据成功',\r\n showCancel: false,\r\n })\r\n },\r\n clearStorage: function () {\r\n this.key = ''\r\n this.data = ''\r\n uni.clearStorage({\r\n success: function (_) {\r\n uni.showModal({\r\n title: '清除数据成功',\r\n showCancel: false,\r\n })\r\n },\r\n fail: function (_) {\r\n uni.showModal({\r\n title: '清除数据失败',\r\n showCancel: false,\r\n })\r\n },\r\n })\r\n },\r\n clearStorageSync: function () {\r\n this.key = ''\r\n this.data = ''\r\n uni.clearStorageSync()\r\n uni.showModal({\r\n title: '清除数据成功',\r\n content: ' ',\r\n showCancel: false,\r\n })\r\n },\r\n },\r\n }\r\n\n```\n\n:::"},"getFileSystemManager":{"name":"## uni.getFileSystemManager() @getfilesystemmanager","description":"\r\n获取文件管理器","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [FileSystemManager](#filesystemmanager-values) | \n\n#### FileSystemManager 的方法 @filesystemmanager-values \n\n#### readFile(options) @readfile\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ReadFileOptions](#readfileoptions-values) | 是 | - | - |\n###### ReadFileOptions 的属性值 @readfileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| encoding | string | 是 | - | base64 / utf-8 |\n| filePath | string | 是 | - | 文件路径,支持相对地址和绝对地址 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | 通用的错误返回结果回调 |\n| complete | Function \\| null | 否 | - | 通用的结束返回结果回调 |\n\n\n\n\n#### writeFile(options) @writefile\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [WriteFileOptions](#writefileoptions-values) | 是 | - | - |\n###### WriteFileOptions 的属性值 @writefileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string | 是 | - | 文件路径,只支持绝对地址 |\n| encoding | string | 是 | - | 指定写入文件的字符编码 支持:ascii base64 utf-8 |\n| data | string | 是 | - | 写入的文本内容 |\n| success | Function \\| null | 否 | - | 通用的正确返回结果回调 |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n\n#### unlink(options) @unlink\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UnLinkOptions](#unlinkoptions-values) | 是 | - | - |\n###### UnLinkOptions 的属性值 @unlinkoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string | 是 | - | 文件路径,只支持绝对地址 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n\n#### mkdir(options) @mkdir\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [MkDirOptions](#mkdiroptions-values) | 是 | - | - |\n###### MkDirOptions 的属性值 @mkdiroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| dirPath | string | 是 | - | 创建的目录路径 (本地路径) |\n| recursive | boolean | 是 | - | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n\n#### rmdir(options) @rmdir\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RmDirOptions](#rmdiroptions-values) | 是 | - | - |\n###### RmDirOptions 的属性值 @rmdiroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| dirPath | string | 是 | - | 要删除的目录路径 (本地路径) |\n| recursive | boolean | 是 | - | 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n\n#### readdir(options) @readdir\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [ReadDirOptions](#readdiroptions-values) | 是 | - | - |\n###### ReadDirOptions 的属性值 @readdiroptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| dirPath | string | 是 | - | 要读取的目录路径 (本地路径) |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n\n#### access(options) @access\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [AccessOptions](#accessoptions-values) | 是 | - | - |\n###### AccessOptions 的属性值 @accessoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string | 是 | - | 要删除的目录路径 (本地路径) |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n\n#### rename(options) @rename\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [RenameOptions](#renameoptions-values) | 是 | - | - |\n###### RenameOptions 的属性值 @renameoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| oldPath | string | 是 | - | 源文件路径,支持本地路径 |\n| newPath | string | 是 | - | 新文件路径,支持本地路径 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n\n#### copyFile(options) @copyfile\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [CopyFileOptions](#copyfileoptions-values) | 是 | - | - |\n###### CopyFileOptions 的属性值 @copyfileoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| srcPath | string | 是 | - | 源文件路径,支持本地路径 |\n| destPath | string | 是 | - | 新文件路径,支持本地路径 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n\n#### getFileInfo(options) @getfileinfo\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [GetFileInfoOptions](#getfileinfooptions-values) | 是 | - | - |\n###### GetFileInfoOptions 的属性值 @getfileinfooptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string | 是 | - | 要读取的文件路径 (本地路径) |\n| digestAlgorithm | string \\| null | 否 | - | |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n\n#### stat(options) @stat\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [StatOptions](#statoptions-values) | 是 | - | - |\n###### StatOptions 的属性值 @statoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| path | string | 是 | - | 文件/目录路径 (本地路径) |\n| recursive | boolean | 是 | - | 是否递归获取目录下的每个文件的 Stats 信息 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n\n\n","compatibility":"### getFileSystemManager 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | x | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.file.filemanager.getFileSystemManager)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-file-system-manager/get-file-system-manager.uvue) \n ```vue\n\r\n \r\n \r\n \r\n 显示简易操作日志,详细日志需真机运行查看\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"getUniverifyManager":{"name":"## uni.getUniverifyManager() @getuniverifymanager","description":"获取一键登录管理对象","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniverifyManager](#univerifymanager-values) | \n\n#### UniverifyManager 的方法 @univerifymanager-values \n\n#### preLogin(options) @prelogin\n预登录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [PreLoginOptions](#preloginoptions-values) | 是 | - | 预登录参数 |\n###### PreLoginOptions 的属性值 @preloginoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| success | () => void | 否 | - | - |\n| fail | (err: [PreLoginFail](#preloginfail-values)) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n###### PreLoginFail 的属性值 @preloginfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 1000 \\| 1001 \\| 1002 \\| 1004 \\| 4001 \\| 30004 \\| 30005 \\| 30006 | 是 | - | 1000 当前应用appid尚未开通uni一键登录
1001 应用所有者账号信息异常,请检查账号一键登录服务是否正常
1002 应用所有者账号信息异常,请检查账号余额是否充足
1004 uni一键登录应用不存在
4001 参数异常
30004 其他错误
30005 预登录失败
30006 一键登录失败 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| errMsg | string | 是 | - | - |\n\n\n##### preLogin 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n\n\n#### login(options) @login\n登录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [LoginOptions](#loginoptions-values) | 是 | - | 登录参数 |\n###### LoginOptions 的属性值 @loginoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| univerifyStyle | [UniverifyStyle](#univerifystyle-values) | 否 | - | 登录页样式 |\n| success | (res: [LoginSuccess](#loginsuccess-values)) => void | 否 | - | - |\n| fail | (err: [LoginFail](#loginfail-values)) => void | 否 | - | - |\n| complete | (res: any) => void | 否 | - | - |\n\n###### UniverifyStyle 的属性值 @univerifystyle-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fullScreen | boolean | 否 | - | 是否全屏 |\n| logoPath | string | 否 | - | logo路径 |\n| backgroundColor | string | 否 | - | 登录页背景色 |\n| loginBtnText | string | 否 | - | 登录按钮文字 |\n\n###### LoginSuccess 的属性值 @loginsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| openId | string | 是 | - | 登录授权唯一标识 |\n| accessToken | string | 是 | - | token |\n\n###### LoginFail 的属性值 @loginfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | 1000 \\| 1001 \\| 1002 \\| 1004 \\| 4001 \\| 30004 \\| 30005 \\| 30006 | 是 | - | 1000 当前应用appid尚未开通uni一键登录
1001 应用所有者账号信息异常,请检查账号一键登录服务是否正常
1002 应用所有者账号信息异常,请检查账号余额是否充足
1004 uni一键登录应用不存在
4001 参数异常
30004 其他错误
30005 预登录失败
30006 一键登录失败 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| errMsg | string | 是 | - | - |\n\n\n##### login 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n\n\n#### close() @close\n关闭登录页\n\n\n##### close 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n\n\n#### isPreLoginValid() @ispreloginvalid\n预登录是否有效\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| boolean | \n\n##### isPreLoginValid 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n\n","compatibility":"### getUniverifyManager 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n","tutorial":"\n### 参见\n[getUniverifyManager](https://uniapp.dcloud.net.cn/univerify.html#univerifymanager)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.univerify.getUniverifyManager)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-univerify-manager/get-univerify-manager.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"getFacialRecognitionMetaInfo":{"name":"## uni.getFacialRecognitionMetaInfo() @getfacialrecognitionmetainfo","description":"获取阿里云实人认证meta info","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"### getFacialRecognitionMetaInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 3.9 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.facial-recognition-verify.getFacialRecognitionMetaInfo)\n"},"startFacialRecognitionVerify":{"name":"## uni.startFacialRecognitionVerify(faceStyle) @startfacialrecognitionverify","description":"启动人脸识别","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| faceStyle | [StartFacialRecognitionVerifyOptions](#startfacialrecognitionverifyoptions-values) | 是 | - | - |\n#### StartFacialRecognitionVerifyOptions 的属性值 @startfacialrecognitionverifyoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| certifyId | string | 是 | - | certifyId 调用实人认证的id |\n| progressBarColor | string \\| null | 否 | - | |\n| screenOrientation | Union \\| null | 否 | \"port\" | 认证时屏幕方向
- land 横屏
- port 竖屏 |\n| success | Function \\| null | 否 | - | |\n| fail | Function \\| null | 否 | - | |\n| complete | Function \\| null | 否 | - | |\n\n##### StartFacialRecognitionVerifyOptions 兼容性 \n| | Android | iOS | web |\n| :- | :- | :- | :- |\n| screenOrientation | 3.9 | x | - |\n","returnValue":"","compatibility":"### startFacialRecognitionVerify 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 3.9 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.facial-recognition-verify.startFacialRecognitionVerify)\n"},"facial-recognition-verify":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/facial-recognition-verify/facial-recognition-verify.uvue) \n ```vue\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"createRewardedVideoAd":{"name":"## uni.createRewardedVideoAd(option) @createrewardedvideoad","description":"创建激励视频广告对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| option | [CreateRewardedVideoAdOptions](#createrewardedvideoadoptions-values) | 是 | - | - |\n#### CreateRewardedVideoAdOptions 的属性值 @createrewardedvideoadoptions-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| adpid | string | 是 | - | 广告位 id |\n| urlCallback | interface \\| null | 否 | - | |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RewardedVideoAd](#rewardedvideoad-values) | \n\n#### RewardedVideoAd 的方法 @rewardedvideoad-values \n\n#### show() @show\n\r\n广告加载成功之后,调用此方法展示广告\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\ | \n\n\n\n#### load() @load\n\r\n加载广告\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\ | \n\n\n\n#### destroy() @destroy\n\r\n销毁广告\n\n\n\n\n#### onLoad(callback) @onload\n\r\n绑定广告 load 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n\n\n\n#### offLoad(callback) @offload\n\r\n解除绑定 load 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n\n\n\n#### onError(callback) @onerror\n\r\n绑定 error 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | - | - |\n###### IUniAdError 的属性值 @iuniaderror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errCode | number | 是 | - | 错误码 - -5001 广告位标识adpid为空,请传入有效的adpid - -5002 无效的广告位标识adpid,请使用正确的adpid - -5003 广告位未开通广告,请在广告平台申请并确保已审核通过 - -5004 无广告模块,打包时请配置要使用的广告模块 - -5005 广告加载失败,请稍后重试 - -5006 广告已经展示过了,请重新加载 - -5007 广告不可用或已过期,请重新请求 - -5008 广告不可用或已过期,请重新请求 - -5009 广告类型不符,请检查后再试 - -5011 打包或开通的渠道,不支持此类型广告 - -5013 广告播放失败,请重新加载 |\n| errSubject | string | 是 | - | 统一错误主题(模块)名称 |\n| data | any \\| null | 否 | - | |\n| cause | interface \\| null | 否 | - | |\n| errMsg | string | 是 | - | - |\n\n\n\n\n#### offError(callback) @offerror\n\r\n解除绑定 error 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | - | - |\n\n\n\n#### onClose(callback) @onclose\n\r\n绑定 close 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [VideoAdClose](#videoadclose-values)) => void | 是 | - | - |\n###### VideoAdClose 的属性值 @videoadclose-values \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| isEnded | boolean | 是 | - | true标识广告播放完毕或者达到发放奖励的条件 |\n\n\n\n\n#### offClose(callback) @offclose\n\r\n解除绑定 close 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [VideoAdClose](#videoadclose-values)) => void | 是 | - | - |\n\n\n\n#### onAdClicked(callback) @onadclicked\n\r\n绑定广告可点击屏幕区域事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: any) => void | 是 | - | - |\n\n\n\n#### onVerify(callback) @onverify\n\r\n绑定 verify 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (result: [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)) => void | 是 | - | - |\n\n\n","compatibility":"### createRewardedVideoAd 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 4.0 | - | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ad.createRewardedVideoAd)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/rewarded-video-ad/rewarded-video-ad.uvue) \n ```vue\n\r\n \r\n \r\n\r\n\r\n\r\n\r\n\r\n\n```"},"createWebviewContext":{"name":"## uni.createWebviewContext(webviewId, component?) @createwebviewcontext","description":"创建 web-view 组件的上下文对象,用于操作 web-view 的行为。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| webviewId | string.WebviewIdString | 是 | - | - |\n| component | ComponentPublicInstance \\| null | 否 | - | |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| interface \\| null | 否 | \n","compatibility":"### createWebviewContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | - | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-webview-context)\n"},"createVideoContext":{"name":"## uni.createVideoContext(videoId, component?) @createvideocontext","description":"创建并返回 video 上下文 videoContext 对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| videoId | string.VideoIdString | 是 | - | - |\n| component | ComponentPublicInstance \\| null | 否 | - | |","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| interface \\| null | 否 | \n","compatibility":"### createVideoContext 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | √ | - | 4.0 |\n","tutorial":"\n### 参见\n[createVideoContext](http://uniapp.dcloud.io/api/media/video-context?id=createVideoContext)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-video-context)\n"},"general_type":{"name":"## 通用类型\n","param":"### GeneralCallbackResult \n\n| 名称 | 类型 | 必备 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| errMsg | string | 是 | - | 错误信息 |\n"}}
\ No newline at end of file
diff --git a/docs/.vuepress/utils/utsJson.json b/docs/.vuepress/utils/utsJson.json
index 90812fd5eaf4de3c0864e386429d6b172ae2f41e..1c87dfa6c703b4f4156851442fdbe6589c7cc482 100644
--- a/docs/.vuepress/utils/utsJson.json
+++ b/docs/.vuepress/utils/utsJson.json
@@ -1 +1,3378 @@
-{"String":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.String)","length":{"name":"### length","description":"\r\n返回字符串的 UTF-16 码元长度。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"charAt":{"name":"### charAt(pos)","description":"\r\n返回一个由给定索引处的单个 UTF-16 码元构成的新字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| pos | number | 是 | 要返回的字符的索引,从零开始。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个字符串,该字符串表示指定 index 处的字符(恰好是一个 UTF-16 码元)。如果 index 超出了 0 – str.length - 1 的范围,charAt() 将返回一个空字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"charCodeAt":{"name":"### charCodeAt(index)","description":"\r\n返回 0 到 65535 之间的整数,表示给定索引处的 UTF-16 代码单元","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | 一个大于等于 0,小于字符串长度的整数。如果不是一个数值,则默认为 0。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 指定 index 处字符的 UTF-16 代码单元值的一个数字;如果 index 超出范围,charCodeAt() 返回 NaN。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"concat":{"name":"### concat(strings)","description":"\r\n将字符串参数连接到调用的字符串,并返回一个新的字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| strings | string[\\] | 是 | T要连接到 str 的一个或多个字符串。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个包含所提供的多个字符串文本组合的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"indexOf":{"name":"### indexOf(searchString, position?)","description":"\r\n在字符串中搜索指定子字符串,并返回其第一次出现的位置索引。它可以接受一个可选的参数指定搜索的起始位置,如果找到了指定的子字符串,则返回的位置索引大于或等于指定的数字。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要搜索的子字符串。 |\n| position | number | 否 | 该方法返回指定子字符串在大于或等于 position 位置的第一次出现的索引,默认为 0。如果 position 大于调用字符串的长度,则该方法根本不搜索调用字符串。如果 position 小于零,该方法的行为就像 position 为 0 时一样。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 查找的字符串 searchValue 的第一次出现的索引,如果没有找到,则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"lastIndexOf":{"name":"### lastIndexOf(searchString, position?)","description":"\r\n搜索该字符串并返回指定子字符串最后一次出现的索引。它可以接受一个可选的起始位置参数,并返回指定子字符串在小于或等于指定数字的索引中的最后一次出现的位置。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要搜索的子字符串。 |\n| position | number | 否 | 该方法返回指定子字符串在小于或等于 position 的位置中的最后一次出现的索引,默认为 +Infinity。如果 position 大于调用字符串的长度,则该方法将搜索整个字符串。如果 position 小于 0,则行为与 0 相同,即该方法只在索引 0 处查找指定的子字符串。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 如果找到了 searchString,则返回最后一次出现的索引,否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"replace":{"name":"### replace(searchValue, replaceValue)","description":"\r\n返回一个由替换值(replacement)替换部分或所有的模式(pattern)匹配项后的新字符串。模式可以是一个字符串或者一个正则表达式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchValue | string \\| RegExp | 是 | RegExp: 一个RegExp 对象或者其字面量。该正则所匹配的内容会被第二个参数的返回值替换掉。string: 一个将被 newSubStr 替换的 字符串。其被视为一整个字符串,而不是一个正则表达式。仅第一个匹配项会被替换。 |\n| replaceValue | string | 是 | 用于替换掉第一个参数在原字符串中的匹配部分的字符串。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个部分或全部匹配由替代模式所取代的新的字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"replace_1":{"name":"### replace(searchValue, replacer)","description":"\r\n返回一个由替换值(replacement)替换部分或所有的模式(pattern)匹配项后的新字符串。模式可以是一个字符串或者一个正则表达式,替换值是一个每次匹配都要调用的回调函数。如果pattern是字符串,则仅替换第一个匹配项。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchValue | string \\| RegExp | 是 | RegExp: 一个RegExp 对象或者其字面量。该正则所匹配的内容会被第二个参数的返回值替换掉。string: 一个将被 newSubStr 替换的 字符串。其被视为一整个字符串,而不是一个正则表达式。仅第一个匹配项会被替换。 |\n| replacer | (substring : string, ...args : any[\\]) => string | 是 | 一个用来创建新子字符串的函数,该函数的返回值将替换掉第一个参数匹配到的结果。在iOS中replacer的第二个参数是字符串数组而非可变参数。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个部分或全部匹配由替代模式所取代的新的字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"search":{"name":"### search(regexp)","description":"\r\nsearch() 方法执行正则表达式和 String 对象之间的一个搜索匹配。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| regexp | string \\| RegExp | 是 | 一个正则表达式(regular expression)对象。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 如果匹配成功,则 search() 返回正则表达式在字符串中首次匹配项的索引;否则,返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"slice":{"name":"### slice(start?, end?)","description":"\r\nslice() 方法提取某个字符串的一部分,并返回一个新的字符串,且不会改动原字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| start | number | 否 | 可选。从该索引(以 0 为基数)处开始提取原字符串中的字符。如果值为负数,会被当做 strLength + beginIndex 看待,这里的strLength 是字符串的长度(例如,如果 beginIndex 是 -3 则看作是:strLength - 3) |\n| end | number | 否 | 可选。在该索引(以 0 为基数)处结束提取字符串。如果省略该参数,slice() 会一直提取到字符串末尾。如果该参数为负数,则被看作是 strLength + endIndex,这里的 strLength 就是字符串的长度 (例如,如果 endIndex 是 -3,则是,strLength - 3)。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个从原字符串中提取出来的新字符串 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"split":{"name":"### split(separator, limit?)","description":"\r\nsplit() 方法接受一个模式,通过搜索模式将字符串分割成一个有序的子串列表,将这些子串放入一个数组,并返回该数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| separator | string \\| RegExp | 是 | 描述每个分割应该发生在哪里的模式。 |\n| limit | number | 否 | 一个非负整数,指定数组中包含的子字符串的数量限制。当提供此参数时,split 方法会在指定 separator 每次出现时分割该字符串,但在已经有 limit 个元素时停止分割。任何剩余的文本都不会包含在数组中。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string[\\] | 在给定字符串中出现 separator 的每一个点上进行分割而成的字符串数组。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"substring":{"name":"### substring(start, end?)","description":"\r\n返回一个字符串在开始索引到结束索引之间的一个子集,或从开始索引直到字符串的末尾的一个子集。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| start | number | 是 | 要截取的第一个字符的索引,该索引位置的字符作为返回的字符串的首字母。 |\n| end | number | 否 | 可选。一个 0 到字符串长度之间的整数,以该数字为索引的字符不包含在截取的字符串内。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含给定字符串的指定部分的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"toLowerCase":{"name":"### toLowerCase()","description":"toLowerCase() 会将调用该方法的字符串值转为小写形式,并返回。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新的字符串,表示转换为小写的调用字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"toUpperCase":{"name":"### toUpperCase()","description":"\r\n将调用该方法的字符串转为大写形式并返回(如果调用该方法的值不是字符串类型会被强制转换)。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新的字符串,表示转换为大写的调用字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"trim":{"name":"### trim()","description":"\r\n从字符串的两端清除空格,返回一个新的字符串,而不修改原始字符串。此上下文中的空格是指所有的空白字符(空格、tab、不换行空格等)以及所有行终止符字符(如 LF、CR 等)。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个表示 str 去掉了开头和结尾的空白字符后的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"padStart":{"name":"### padStart(targetLength, padString?)","description":"\r\n用另一个字符串填充当前字符串(如果需要会重复填充),直到达到给定的长度。填充是从当前字符串的开头开始的。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| targetLength | number | 是 | 当前 str 填充后的长度。如果该值小于或等于 str.length,则会直接返回当前 str。 |\n| padString | string | 否 | 可选。用于填充当前 str 的字符串。如果 padString 太长,无法适应 targetLength,则会从末尾被截断。默认值为“ ”字符(U+0020)。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 在开头填充 padString 直到达到给定的 targetLength 所形成的 String。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"padEnd":{"name":"### padEnd(targetLength, padString?)","description":"\r\n将当前字符串从末尾开始填充给定的字符串(如果需要会重复填充),直到达到给定的长度。填充是从当前字符串的末尾开始的。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| targetLength | number | 是 | 当前 str 填充后的长度。如果该值小于或等于 str.length,则会直接返回当前 str。 |\n| padString | string | 否 | 可选。用于填充当前 str 的字符串。如果 padString 太长,无法适应 targetLength,则会被截断。默认值为“ ”字符(U+0020)。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 在开头填充 padString 直到达到给定的 targetLength 所形成的 String。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"includes":{"name":"### includes(searchString, position?)","description":"\r\n如果 searchString 作为此对象转换为 String 的结果的子字符串出现在大于或等于position的一个或多个位置,则返回 true;否则,返回 false。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要在 str 中搜索的字符串。不能是正则表达式。 |\n| position | number | 否 | 在字符串中开始搜索 searchString 的位置。(默认为 0。) |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果在给定的字符串中找到了要搜索的字符串(包括 searchString 为空字符串的情况),则返回 true,否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"endsWith":{"name":"### endsWith(searchString, endPosition?)","description":"\r\nendsWith() 方法用于判断一个字符串是否以指定字符串结尾,如果是则返回 true,否则返回 false。该方法区分大小写。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要搜索的作为结尾的字符串,不能是正则表达式。所有非正则表达式的值都会被强制转换为字符串。 |\n| endPosition | number | 否 | 可选,预期找到 searchString 的末尾位置(即 searchString 最后一个字符的索引加 1)。默认为 str.length。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果被检索字符串的末尾出现了指定的字符串(包括 searchString 为空字符串的情况),则返回 true;否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"repeat":{"name":"### repeat(count)","description":"\r\nrepeat() 构造并返回一个新字符串,该字符串包含被连接在一起的指定数量的字符串的副本。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| count | number | 是 | 介于 0 和 +Infinity 之间的整数。表示在新构造的字符串中重复了多少遍原字符串。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含指定字符串的指定数量副本的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"startsWith":{"name":"### startsWith(searchString, position?)","description":"\r\nstartsWith() 方法用来判断当前字符串是否以另外一个给定的子字符串开头,并根据判断结果返回 true 或 false。这个方法区分大小写。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要搜索的子字符串。 |\n| position | number | 否 | 在 str 中搜索 searchString 的开始位置,默认值为 0。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果在字符串的开头找到了给定的字符则返回 true;否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"at":{"name":"### at(index)","description":"\r\n方法接受一个整数值,并返回一个新的 String,该字符串由位于指定偏移量处的单个 UTF-16 码元组成","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | 字符指定偏移量处,允许正整数和负整数,负整数从字符串中的最后一个字符开始倒数。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string \\| null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"fromCharCode":{"name":"### fromCharCode(codes)","description":"","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| codes | number[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","itemType":"method"}},"Number":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Number)","toString":{"name":"### toString(radix?)","description":"\r\n返回指定 Number 对象的字符串表示形式。如果转换的基数大于 10,则会使用字母来表示大于 9 的数字,比如基数为 16 的情况,则使用 a 到 f 的字母来表示 10 到 15。如果基数没有指定,则使用 10。如果对象是负数,则会保留负号。即使 radix 是 2 时也是如此:返回的字符串包含一个负号(-)前缀和正数的二进制表示,不是 数值的二进制补码。进行数字到字符串的转换时,建议用小括号将要转换的目标括起来,防止出错。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| radix | number | 否 | 指定要用于数字到字符串的转换的基数 (从 2 到 36)。如果未指定 radix 参数,则默认值为 10。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"toFixed":{"name":"### toFixed(fractionDigits?)","description":"\r\n使用定点表示法来格式化一个数值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| fractionDigits | number | 否 | 小数点后数字的个数;介于 0 到 20(包括)之间,实现环境可能支持更大范围。如果忽略该参数,则默认为 0。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 使用定点表示法表示给定数字的字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"valueOf":{"name":"### valueOf()","description":"\r\n返回一个被 Number 对象包装的原始值。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 表示指定 Number 对象的原始值的数字。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"toInt":{"name":"### toInt()","description":"\r\n返回一个Int 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int | 返回 number 对应的 Int 值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"},"toFloat":{"name":"### toFloat()","description":"\r\n返回一个Float 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Float | 返回 number 对应的 Float 值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"},"toDouble":{"name":"### toDouble()","description":"\r\n返回一个 Double 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Double | 返回 number 对应的 Double 值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"},"toInt64":{"name":"### toInt64()","description":"\r\n返回一个 Int64 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int64 | 返回 number 对应的 Int64 值。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | x |\n","itemType":"method"},"toInt32":{"name":"### toInt32()","description":"\r\n返回一个 Int32 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int32 | 返回 number 对应的 Int32 值。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | x |\n","itemType":"method"},"toInt16":{"name":"### toInt16()","description":"\r\n返回一个 Int16 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int16 | 返回 number 对应的 Int16 值。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | x |\n","itemType":"method"},"toInt8":{"name":"### toInt8()","description":"\r\n返回一个 Int8 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int8 | 返回 number 对应的 Int8 值。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | x |\n","itemType":"method"},"toUInt":{"name":"### toUInt()","description":"\r\n返回一个 UInt 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt | 返回 number 对应的 UInt 值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"},"toUInt64":{"name":"### toUInt64()","description":"\r\n返回一个 UInt64 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt64 | 返回 number 对应的 UInt64 值。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | x |\n","itemType":"method"},"toUInt32":{"name":"### toUInt32()","description":"\r\n返回一个 UInt32 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt32 | 返回 number 对应的 UInt32 值。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | x |\n","itemType":"method"},"toUInt16":{"name":"### toUInt16()","description":"\r\n返回一个 UInt16 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt16 | 返回 number 对应的 UInt16 值。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | x |\n","itemType":"method"},"toUInt8":{"name":"### toUInt8()","description":"\r\n返回一个 UInt8 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt8 | 返回 number 对应的 UInt8 值。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | x |\n","itemType":"method"},"toByte":{"name":"### toByte()","description":"\r\n将当前的Number数据转换为Byte表示,如果超出Byte最大值表示范围,会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Byte | 返回 number 对应的 Byte 值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"},"toLong":{"name":"### toLong()","description":"\r\n将当前的Number数据转换为Long表示,如果超出Long最大值表示范围,会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Long | 返回 number 对应的 Long 值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"},"toShort":{"name":"### toShort()","description":"\r\n将当前的Number数据转换为Short表示,如果超出Short最大值表示范围,会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Short | 返回 number 对应的 Short 值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"},"toUShort":{"name":"### toUShort()","description":"\r\n将当前的 Number 数据转换为 UShort 表示,如果超出 UShort 最大值表示范围,会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UShort | 返回 number 对应的 UShort 值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"},"toULong":{"name":"### toULong()","description":"\r\n将当前的 Number 数据转换为 ULong 表示,如果超出 ULong 最大值表示范围,会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| ULong | 返回 number 对应的 ULong 值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"},"from":{"name":"### from(value)","description":"\r\n通过 Int \\| Float \\| Double \\| Int64 \\| Int32 \\| Int16 \\| Int8 \\| UInt \\| UInt64 \\| UInt32 \\| UInt16 \\| UInt8 \\| Byte \\| Short \\| Long 类型创建一个 number","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Int \\| Float \\| Double \\| Int64 \\| Int32 \\| Int16 \\| Int8 \\| UInt \\| UInt64 \\| UInt32 \\| UInt16 \\| UInt8 \\| Byte \\| Short \\| Long | 是 | 必填。一个 Swfit 或者 Kottlin 专有数字类型的值。其中 Swift 平台 支持 Int, Float, Double, Int64, Int32, Int16, Int8, UInt, UInt64, UInt32, UInt16, UInt8。Kottlin 平台支持 Int, Float, Double, Byte, Short, Long |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回 number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |\n","itemType":"method"}},"Math":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Math)","E":{"name":"### E","description":"\r\nMath.E 属性表示自然对数的底数(或称为基数),e,约等于 2.718。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"LN10":{"name":"### LN10","description":"\r\nMath.LN10 属性表示 10 的自然对数,约为 2.302\r\n","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"LN2":{"name":"### LN2","description":"\r\nMath.LN2 属性表示 2 的自然对数,约为 0.693","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"LOG2E":{"name":"### LOG2E","description":"\r\nMath.LOG2E 属性表示以 2 为底数,e 的对数,约为 1.442","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"LOG10E":{"name":"### LOG10E","description":"\r\nMath.LOG10E 属性表示以 10 为底数,e 的对数,约为 0.434","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"PI":{"name":"### PI","description":"\r\nMath.PI 表示一个圆的周长与直径的比例,约为 3.14159","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"SQRT1_2":{"name":"### SQRT1_2","description":"\r\nMath.SQRT1_2 属性表示 1/2 的平方根,约为 0.707","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"SQRT2":{"name":"### SQRT2","description":"\r\nMath.SQRT2 属性表示 2 的平方根,约为 1.414","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"abs":{"name":"### abs(x)","description":"\r\nRMath.abs(x) 函数返回一个数字的绝对值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数字 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | x 的绝对值。如果 x 是负数(包括 -0),则返回 -x。否则,返回 x | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"acos":{"name":"### acos(x)","description":"\r\nMath.acos() 返回一个数的反余弦值(单位为弧度)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值. |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"asin":{"name":"### asin(x)","description":"\r\nMath.asin() 方法返回一个数值的反正弦(单位为弧度)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"atan":{"name":"### atan(x)","description":"\r\nMath.atan() 函数返回一个数值的反正切(以弧度为单位)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"atan2":{"name":"### atan2(y, x)","description":"\r\nMath.atan2() 返回从原点 (0,0) 到 (x,y) 点的线段与 x 轴正方向之间的平面角度 (弧度值),也就是 Math.atan2(y,x)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| y | number | 是 | 数值 |\n| x | number | 是 | 数值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"ceil":{"name":"### ceil(x)","description":"\r\nMath.ceil() 函数总是四舍五入并返回大于等于给定数字的最小整数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"cos":{"name":"### cos(x)","description":"\r\nMath.cos() 函数返回一个数值的余弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个以弧度为单位的数值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"exp":{"name":"### exp(x)","description":"\r\nMath.exp() 函数返回 e^x,x 表示参数,e 是欧拉常数(Euler's constant),自然对数的底数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"floor":{"name":"### floor(x)","description":"\r\nMath.floor() 函数总是返回小于等于一个给定数字的最大整数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数字。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"log":{"name":"### log(x)","description":"\r\nMath.log() 函数返回一个数的自然对数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数字。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"max":{"name":"### max(values)","description":"\r\nMath.max() 函数返回作为输入参数的最大数字,如果没有参数,则返回 -Infinity","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| values | number[\\] | 是 | 0 个或多个数字,将在其中选择,并返回最大的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定数值中最大的数。如果任一参数不能转换为数值,则返回 NaN。如果没有提供参数,返回 -Infinity。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"min":{"name":"### min(values)","description":"\r\nMath.min() 函数返回作为输入参数的数字中最小的一个,如果没有参数,则返回 Infinity。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| values | number[\\] | 是 | 0 个或多个数字,将在其中选择,并返回最小值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定数值中最小的数。如果任一参数不能转换为数值,则返回 NaN。如果没有提供参数,返回 Infinity。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"pow":{"name":"### pow(x, y)","description":"\r\nMath.pow() 函数返回基数(base)的指数(exponent)次幂,即 base^exponent。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 基数 |\n| y | number | 是 | 指数 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"random":{"name":"### random()","description":"\r\nMath.random() 函数返回一个浮点数,伪随机数在范围从0 到小于1,也就是说,从 0(包括 0)往上,但是不包括 1(排除 1),然后您可以缩放到所需的范围。实现将初始种子选择到随机数生成算法;它不能被用户选择或重置。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个浮点型伪随机数字,在0(包括 0)和1(不包括)之间。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"round":{"name":"### round(x)","description":"\r\nMath.round() 函数返回一个数字四舍五入后最接近的整数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定数字的值四舍五入到最接近的整数。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"sin":{"name":"### sin(x)","description":"\r\nMath.sin() 函数返回一个数值的正弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值(以弧度为单位)。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"sqrt":{"name":"### sqrt(x)","description":"\r\nMath.sqrt() 函数返回一个数的平方根","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"tan":{"name":"### tan(x)","description":"\r\nMath.tan() 方法返回一个数值的正切值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值,表示一个角(单位:弧度)。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"clz32":{"name":"### clz32(x)","description":"\r\nMath.clz32() 函数返回一个数字在转换成 32 无符号整形数字的二进制形式后,开头的 0 的个数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数字。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"sign":{"name":"### sign(x)","description":"\r\nMath.sin() 函数返回一个数值的正弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值(以弧度为单位)。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"log10":{"name":"### log10(x)","description":"\r\nMath.log10() 函数返回一个数字以 10 为底的对数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 任意数字。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"log2":{"name":"### log2(x)","description":"\r\nMath.log2() 函数返回一个数字以 2 为底的对数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 任意数字。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"log1p":{"name":"### log1p(x)","description":"\r\nMath.log1p() 函数返回一个数字加 1 后的自然对数 (底为 E), 既log(x+1).","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 任意数字。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"expm1":{"name":"### expm1(x)","description":"\r\nMath.expm1() 函数返回 E^x - 1, 其中 x 是该函数的参数,E 是自然对数的底数 2.718281828459045。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 任意数字。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"cosh":{"name":"### cosh(x)","description":"\r\nMath.cosh() 函数返回数值的双曲余弦函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 数值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"sinh":{"name":"### sinh(x)","description":"\r\nMath.sinh() 函数返回一个数字 (单位为角度) 的双曲正弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 任意数字 (单位为度). |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"tanh":{"name":"### tanh(x)","description":"\r\nMath.tanh() 函数将会返回一个数的双曲正切函数值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 待计算的数字。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"acosh":{"name":"### acosh(x)","description":"\r\nMath.acosh() 函数返回一个数的反双曲余弦值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数字。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"asinh":{"name":"### asinh(x)","description":"\r\nMath.asinh() 返回一个数值的反双曲正弦值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"atanh":{"name":"### atanh(x)","description":"\r\nMath.atanh() 函数返回一个数值反双曲正切值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个数值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"trunc":{"name":"### trunc(x)","description":"\r\nMath.trunc() 方法会将数字的小数部分去掉,只保留整数部分。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 任意数字 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"fround":{"name":"### fround(x)","description":"\r\nMath.fround() 可以将任意的数字转换为离它最近的单精度浮点数形式的数字。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 一个 Number。若参数为非数字类型,则会被转投成数字。无法转换时,设置成NaN。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"}},"Date":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Date)","toString":{"name":"### toString()","description":"\r\n返回一个字符串,以本地的时区表示该 Date 对象。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"toDateString":{"name":"### toDateString()","description":"\r\n以美式英语和人类易读的形式返回一个日期对象日期部分的字符串。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getTime":{"name":"### getTime()","description":"\r\n返回从UTC时间1970年1月1日午夜开始以毫秒为单位存储的时间值。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getFullYear":{"name":"### getFullYear()","description":"\r\n根据本地时间返回指定日期的年份。此方法替代 getYear() 。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 根据当地时间,返回一个对应于给定日期的年份数字。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getMonth":{"name":"### getMonth()","description":"\r\n根据本地时间,返回一个指定的日期对象的月份,为基于 0 的值(0 表示一年中的第一月)。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个 0 到 11 的整数值:0 代表一月份,1 代表二月份,2 代表三月份,依次类推。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getDate":{"name":"### getDate()","description":"\r\n根据本地时间,返回一个指定的日期对象为一个月中的哪一日(从 1--31)。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 1 到 31 的整数值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getDay":{"name":"### getDay()","description":"\r\n根据本地时间,返回一个具体日期中一周的第几天,0 表示星期天。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 根据本地时间,返回一个 0 到 6 之间的整数值,代表星期几:0 代表星期日,1 代表星期一,2 代表星期二,依次类推。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getHours":{"name":"### getHours()","description":"\r\n根据本地时间,返回一个指定的日期对象的小时。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 23 之间的整数值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getMinutes":{"name":"### getMinutes()","description":"\r\n根据本地时间,返回一个指定的日期对象的分钟数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getSeconds":{"name":"### getSeconds()","description":"\r\n根据本地时间,返回一个指定的日期对象的秒数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数值。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"setTime":{"name":"### setTime(time)","description":"\r\n以一个表示从 1970-1-1 00:00:00 UTC 计时的毫秒数为来为 Date 对象设置时间。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| time | number | 是 | 一个整数,表示从 1970-1-1 00:00:00 UTC 开始计时的毫秒数。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | UTC 1970 年 1 月 1 日 00:00:00 与更新日期之间的毫秒数(实际上是自变量的值)。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"setMilliseconds":{"name":"### setMilliseconds(ms)","description":"\r\n根据本地时间设置一个日期对象的豪秒数。如果指定的数字超出了合理范围,则日期对象的时间信息会被相应地更新。例如,如果指定了 1005,则秒数加 1,豪秒数为 5。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ms | number | 是 | 一个 0 到 999 的数字,表示豪秒数。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回更新后的时间距 1970 年 1 月 1 日 00:00:00 的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"setSeconds":{"name":"### setSeconds(sec)","description":"\r\n根据本地时间设置一个日期对象的秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| sec | number | 是 | 一个 0 到 59 的整数。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"setMinutes":{"name":"### setMinutes(min)","description":"\r\n根据本地时间为一个日期对象设置分钟数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| min | number | 是 | 一个 0 到 59 的整数,表示分钟数。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"setHours":{"name":"### setHours(hours)","description":"\r\n根据本地时间为一个日期对象设置小时数,返回从 1970-01-01 00:00:00 UTC 到更新后的 日期 对象实例所表示时间的毫秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| hours | number | 是 | 必填,一个 0 到 23 的整数,表示小时。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"setDate":{"name":"### setDate(date)","description":"\r\n根据本地时间来指定一个日期对象的天数。如果 dayValue 超出了月份的合理范围,setDate 将会相应地更新 Date 对象。例如,如果为 dayValue 指定 0,那么日期就会被设置为上个月的最后一天。如果 dayValue 被设置为负数,日期会设置为上个月最后一天往前数这个负数绝对值天数后的日期。-1 会设置为上月最后一天的前一天(译者注:例如当前为 4 月,如果 setDate(-2),则为 3 月 29 日)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| date | number | 是 | 一个整数,表示该月的第几天。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"setMonth":{"name":"### setMonth(month)","description":"\r\n根据本地时间为一个日期对象设置月份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| month | number | 是 | 必填参数,介于 0 到 11 之间的整数(表示一月到十二月)。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 基于 1 January 1970 00:00:00 UTC 开始计算的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"setFullYear":{"name":"### setFullYear(year)","description":"\r\n根据本地时间为一个日期对象设置年份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| year | number | 是 | 指定年份的整数值,例如 1995。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"parse":{"name":"### parse(s)","description":"\r\n解析一个表示某个日期的字符串,并返回从 1970-1-1 00:00:00 UTC 到该日期对象(该日期对象的 UTC 时间)的毫秒数,如果该字符串无法识别,或者一些情况下,包含了不合法的日期数值(如:2015-02-31),则返回值为 NaN。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| s | string | 是 | 一个符合 RFC2822 或 ISO 8601 日期格式的字符串(其他格式也许也支持,但结果可能与预期不符)。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个表示从 1970-1-1 00:00:00 UTC 到给定日期字符串所表示时间的毫秒数的数值。如果参数不能解析为一个有效的日期,则返回NaN。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"now":{"name":"### now()","description":"\r\n返回自 1970 年 1 月 1 日 00:00:00 (UTC) 到当前时间的毫秒数。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"}},"RegExp":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.RegExp)","flags":{"name":"### flags","description":"\r\n返回一个字符串,由当前正则表达式对象的标志组成。此属性是一个只读属性\r\n此字符串中的字符按以下顺序排序和连接:\r\n\r\n - \"g\" for global\r\n - \"i\" for ignoreCase\r\n - \"m\" for multiline\r\n - \"u\" for unicode\r\n - \"y\" for sticky\r\n\r\n如果没有设置标志,则该值为空字符串。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"source":{"name":"### source","description":"\r\n返回一个值为当前正则表达式对象的模式文本的字符串,该字符串不会包含正则字面量两边的斜杠以及任何的标志字符。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"global":{"name":"### global","description":"\r\n表明正则表达式是否使用了 \"g\" 标志。global 是一个正则表达式实例的只读属性。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"ignoreCase":{"name":"### ignoreCase","description":"\r\n表明正则表达式是否使用了 \"i\" 标志。ignoreCase 是正则表达式实例的只读属性。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"multiline":{"name":"### multiline","description":"\r\n表明正则表达式是否使用了 \"m\" 标志。multiline 是正则表达式实例的一个只读属性。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"lastIndex":{"name":"### lastIndex","description":"\r\n正则表达式的一个可读可写的整型属性,用来指定下一次匹配的起始索引。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"exec":{"name":"### exec(string)","description":"\r\n在一个指定字符串中执行一个搜索匹配。返回一个结果数组或 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| string | string | 是 | 要匹配正则表达式的字符串。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| RegExpExecArray \\| null | 如果匹配失败,exec() 方法返回 null,并将正则表达式的 lastIndex 重置为 0。如果匹配成功,exec() 方法返回一个数组,并更新正则表达式对象的 lastIndex 属性。完全匹配成功的文本将作为返回数组的第一项,从第二项起,后续每项都对应一个匹配的捕获组。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"test":{"name":"### test(string)","description":"\r\n执行一个检索,用来查看正则表达式与指定的字符串是否匹配。返回 true 或 false。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| string | string | 是 | 用来与正则表达式匹配的字符串。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果正则表达式与指定的字符串匹配,返回true;否则false。如果正则表达式设置了全局标志,test() 的执行会改变正则表达式 lastIndex属性。连续的执行test()方法,后续的执行将会从 lastIndex 处开始匹配字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"}},"JSON":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.JSON)","parse":{"name":"### parse(text, reviver?)","description":"\r\nJSON.parse() 方法用来解析 JSON 字符串,构造由字符串描述的 JavaScript 值或对象。提供可选的 reviver 函数用以在返回之前对所得到的对象执行变换 (操作)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 要被解析成 JavaScript 值的字符串 |\n| reviver | (this : any, key : string, value : any) => any | 否 | [可选\\] 转换器,如果传入该参数 (函数),可以用来修改解析生成的原始值,调用时机在 parse 函数返回之前。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"parse_1":{"name":"### parse(text)","description":"\r\nJSON.parse() 方法用来解析 JSON 字符串,构造由字符串描述的值或者对象,其类型由泛型参数T决定\r\n如果输入的是一个合法的json值或者对象,返回一个对应的T值或者对象,如果json描述的值或对象和 T 指定的类型不符,将返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 要被解析成 JavaScript 值的字符串 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 返回一个T类型的值或者对象 或者 null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"parseObject":{"name":"### parseObject(text)","description":"\r\nJSON.parseObject() 方法用来解析 JSON 字符串,构造由字符串描述的对象。\r\n如果输入的是一个合法的json对象,返回一个对应的UTSJSONObject,如果是json array 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 要被解析成 JavaScript 值的字符串 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UTSJSONObject \\| null | 返回一个UTSJSONObjet 或者 null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"parseObject_1":{"name":"### parseObject(text)","description":"\r\nJSON.parseObject() 方法用来解析 JSON 字符串,构造由字符串描述的对象,该对象的类型由泛型参数T决定\r\n如果输入的是一个合法的json对象,返回一个对应的T对象,如果是json array 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 要被解析成 JavaScript 值的字符串 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 返回一个T类型对象 或者 null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"parseArray":{"name":"### parseArray(text)","description":"\r\nJSON.parseArray() 方法用来解析 JSON 字符串,构造由字符串描述的数组。数组元素类型为any\r\n如果输入的是一个合法的json数组,返回一个对应的Array,如果是json object 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 要被解析成 JavaScript 值的字符串 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\ \\| null | 返回一个Array 或者 null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"parseArray_1":{"name":"### parseArray(text)","description":"\r\nJSON.parseArray() 方法用来解析 JSON 字符串,构造由字符串描述的数组。数组元素类型由泛型T决定\r\n如果输入的是一个合法的json数组,返回一个对应的Array,如果是json object 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 要被解析成 JavaScript 值的字符串 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\ \\| null | 返回一个Array 或者 null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"stringify":{"name":"### stringify(value)","description":"\r\nJSON.stringify() 方法将一个 JavaScript 对象或值转换为 JSON 字符串,如果指定了一个 replacer 函数,则可以选择性地替换值,或者指定的 replacer 是数组,则可选择性地仅包含数组指定的属性","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | any \\| null | 是 | 将要序列化成 一个 JSON 字符串的值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 3.9 | 4.0 |\n","itemType":"method"}},"Array":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Array)","length":{"name":"### length","description":"\r\nlength 是 Array 的实例属性,表示该数组中元素的个数。该值是一个无符号 32 位整数,并且其数值总是大于数组最大索引。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"toKotlinList":{"name":"### toKotlinList()","description":"\r\ntoKotlinList() 将当前的Array对象转换为 kotlin 中对应的List对象","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| kotlin.collections.List\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","itemType":"method"},"pop":{"name":"### pop()","description":"\r\npop() 方法从数组中删除最后一个元素,并返回该元素的值。此方法会更改数组的长度。\r\n","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T \\| null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"push":{"name":"### push(items)","description":"\r\npush() 方法将指定的元素添加到数组的末尾,并返回新的数组长度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| items | T[\\] | 是 | 添加到数组末尾的元素。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 调用方法的对象的新 length 属性。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"concat":{"name":"### concat(items)","description":"\r\nconcat() 方法用于合并两个或多个数组。此方法不会更改现有数组,而是返回一个新数组。\r\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| items | ConcatArray\\[\\] | 是 | 数组和/或值,将被合并到一个新的数组中。如果省略了所有 valueN 参数,则 concat 会返回调用此方法的现存数组的一个浅拷贝。详情请参阅下文描述。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 新的 Array 实例。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"concat_1":{"name":"### concat(items)","description":"\r\nconcat() 方法用于合并两个或多个数组。此方法不会更改现有数组,而是返回一个新数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| items | (T \\| ConcatArray\\)[\\] | 是 | 数组和/或值,将被合并到一个新的数组中。如果省略了所有 valueN 参数,则 concat 会返回调用此方法的现存数组的一个浅拷贝。详情请参阅下文描述。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 新的 Array 实例。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"join":{"name":"### join(separator?)","description":"\r\njoin() 方法将一个数组(或一个类数组对象)的所有元素连接成一个字符串并返回这个字符串,用逗号或指定的分隔符字符串分隔。如果数组只有一个元素,那么将返回该元素而不使用分隔符。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| separator | string | 否 | 指定一个字符串来分隔数组的每个元素。如果需要,将分隔符转换为字符串。如果省略,数组元素用逗号(,)分隔。如果 separator 是空字符串(\"\"),则所有元素之间都没有任何字符。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个所有数组元素连接的字符串。如果 arr.length 为 0,则返回空字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","itemType":"method"},"reverse":{"name":"### reverse()","description":"\r\nreverse() 方法就地反转数组中的元素,并返回同一数组的引用。数组的第一个元素会变成最后一个,数组的最后一个元素变成第一个。换句话说,数组中的元素顺序将被翻转,变为与之前相反的方向。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 原始数组反转后的引用。注意,数组是就地反转的,并且没有复制。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"shift":{"name":"### shift()","description":"\r\nshift() 方法从数组中删除第一个元素,并返回该元素的值。此方法更改数组的长度。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 从数组中删除的元素;如果数组为空则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"slice":{"name":"### slice(start?, end?)","description":"\r\nslice() 方法返回一个新的数组对象,这一对象是一个由 start 和 end 决定的原数组的浅拷贝(包括 start,不包括 end),其中 start 和 end 代表了数组元素的索引。原始数组不会被改变。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| start | number | 否 | 提取起始处的索引(从 0 开始),会转换为整数。 |\n| end | number | 否 | 提取终止处的索引(从 0 开始),会转换为整数。slice() 会提取到但不包括 end 的位置。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"sort":{"name":"### sort(compareFn?)","description":"\r\nsort() 方法就地对数组的元素进行排序,并返回对相同数组的引用。默认排序是将元素转换为字符串,然后按照它们的 UTF-16 码元值升序排序。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| compareFn | (a : T, b : T) => number | 否 | 定义排序顺序的函数。返回值应该是一个数字,其正负性表示两个元素的相对顺序。该函数使用以下参数调用: a:第一个用于比较的元素。不会是 null。 b:第二个用于比较的元素。不会是 null。 如果省略该函数,数组元素会被转换为字符串,然后根据每个字符的 Unicode 码位值进行排序。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| this | 经过排序的原始数组的引用。注意数组是就地排序的,不会进行复制。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"splice":{"name":"### splice(start, deleteCount, items)","description":"\r\nsplice() 方法通过移除或者替换已存在的元素和/或添加新元素就地改变一个数组的内容。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| start | number | 是 | 从 0 开始计算的索引,表示要开始改变数组的位置,它会被转换成整数。 |\n| deleteCount | number | 是 | 一个整数,表示数组中要从 start 开始删除的元素数量。 |\n| items | T[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 一个包含了删除的元素的数组。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"unshift":{"name":"### unshift(items)","description":"\r\nunshift() 方法将指定元素添加到数组的开头,并返回数组的新长度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| items | T[\\] | 是 | 添加到 arr 开头的元素。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"indexOf":{"name":"### indexOf(searchElement, fromIndex?)","description":"\r\nindexOf() 方法返回数组中第一次出现给定元素的下标,如果不存在则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchElement | T | 是 | 数组中要查找的元素。 |\n| fromIndex | number | 否 | 开始搜索的索引(从零开始),会转换为整数。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"lastIndexOf":{"name":"### lastIndexOf(searchElement, fromIndex?)","description":"\r\nlastIndexOf() 方法返回数组中给定元素最后一次出现的索引,如果不存在则返回 -1。该方法从 fromIndex 开始向前搜索数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchElement | T | 是 | 被查找的元素。 |\n| fromIndex | number | 否 | 以 0 起始的索引,表明反向搜索的起始位置,会被转换为整数。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"every":{"name":"### every(predicate, thisArg?)","description":"\r\nevery() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number, array : T[\\]) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试,否则返回一个假值。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 every() 的数组本身。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"every_1":{"name":"### every(predicate, thisArg?)","description":"\r\nevery() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试,否则返回一个假值。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"every_2":{"name":"### every(predicate, thisArg?)","description":"\r\nevery() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试,否则返回一个假值。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"some":{"name":"### some(predicate, thisArg?)","description":"\r\nsome() 方法测试数组中是否至少有一个元素通过了由提供的函数实现的测试。如果在数组中找到一个元素使得提供的函数返回 true,则返回 true;否则返回 false。它不会修改数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number, array : T[\\]) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试,否则返回一个假值。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 some() 的数组本身。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果回调函数对数组中至少一个元素返回一个真值,则返回 true。否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"some_1":{"name":"### some(predicate, thisArg?)","description":"\r\nsome() 方法测试数组中是否至少有一个元素通过了由提供的函数实现的测试。如果在数组中找到一个元素使得提供的函数返回 true,则返回 true;否则返回 false。它不会修改数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试,否则返回一个假值。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果回调函数对数组中至少一个元素返回一个真值,则返回 true。否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"some_2":{"name":"### some(predicate, thisArg?)","description":"\r\nsome() 方法测试数组中是否至少有一个元素通过了由提供的函数实现的测试。如果在数组中找到一个元素使得提供的函数返回 true,则返回 true;否则返回 false。它不会修改数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试,否则返回一个假值。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果回调函数对数组中至少一个元素返回一个真值,则返回 true。否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"forEach":{"name":"### forEach(callbackfn, thisArg?)","description":"\r\nforEach() 方法对数组的每个元素执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : T, index : number, array : T[\\]) => void | 是 | 为数组中每个元素执行的函数。并会丢弃它的返回值。该函数被调用时将传入以下参数: value:数组中正在处理的当前元素。 index:数组中正在处理的当前元素的索引。 array:调用了 forEach() 的数组本身。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"forEach_1":{"name":"### forEach(callbackfn, thisArg?)","description":"\r\nforEach() 方法对数组的每个元素执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : T, index : number) => void | 是 | 为数组中每个元素执行的函数。并会丢弃它的返回值。该函数被调用时将传入以下参数: value:数组中正在处理的当前元素。 index:数组中正在处理的当前元素的索引。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"forEach_2":{"name":"### forEach(callbackfn, thisArg?)","description":"\r\nforEach() 方法对数组的每个元素执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : T) => void | 是 | 为数组中每个元素执行的函数。并会丢弃它的返回值。该函数被调用时将传入以下参数: value:数组中正在处理的当前元素。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"map":{"name":"### map(callbackfn, thisArg?)","description":"\r\nmap() 方法创建一个新数组,这个新数组由原数组中的每个元素都调用一次提供的函数后的返回值组成。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : T, index : number, array : T[\\]) => U | 是 | 为数组中的每个元素执行的函数。它的返回值作为一个元素被添加为新数组中。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 map() 的数组本身。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U[\\] | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"map_1":{"name":"### map(callbackfn, thisArg?)","description":"\r\nmap() 方法创建一个新数组,这个新数组由原数组中的每个元素都调用一次提供的函数后的返回值组成。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : T, index : number) => U | 是 | 为数组中的每个元素执行的函数。它的返回值作为一个元素被添加为新数组中。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U[\\] | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"map_2":{"name":"### map(callbackfn, thisArg?)","description":"\r\nmap() 方法创建一个新数组,这个新数组由原数组中的每个元素都调用一次提供的函数后的返回值组成。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : T) => U | 是 | 为数组中的每个元素执行的函数。它的返回值作为一个元素被添加为新数组中。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U[\\] | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"filter":{"name":"### filter(predicate, thisArg?)","description":"\r\nfilter() 方法创建给定数组一部分的浅拷贝,其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number, array : T[\\]) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中,否则返回一个假值。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 filter() 的数组本身。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"filter_1":{"name":"### filter(predicate, thisArg?)","description":"\r\nfilter() 方法创建给定数组一部分的浅拷贝,其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中,否则返回一个假值。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"filter_2":{"name":"### filter(predicate, thisArg?)","description":"\r\nfilter() 方法创建给定数组一部分的浅拷贝,其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中,否则返回一个假值。该函数被调用时将传入以下参数: value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduce":{"name":"### reduce(callbackfn)","description":"\r\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数,每一次运行 reducer 会将先前元素的计算结果作为参数传入,最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T, currentIndex : number, array : T[\\]) => T | 是 | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为 array[0\\] 的值。 currentValue:当前元素的值。在第一次调用时,如果指定了 initialValue,则为 array[0\\] 的值,否则为 array[1\\]。 currentIndex:currentValue 在数组中的索引位置。在第一次调用时,如果指定了 initialValue 则为 0,否则为 1 array:调用了 reduce() 的数组本身。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduce_1":{"name":"### reduce(callbackfn)","description":"\r\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数,每一次运行 reducer 会将先前元素的计算结果作为参数传入,最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T, currentIndex : number) => T | 是 | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为 array[0\\] 的值。 currentValue:当前元素的值。在第一次调用时,如果指定了 initialValue,则为 array[0\\] 的值,否则为 array[1\\]。 currentIndex:currentValue 在数组中的索引位置。在第一次调用时,如果指定了 initialValue 则为 0,否则为 1 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduce_2":{"name":"### reduce(callbackfn, initialValue)","description":"\r\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数,每一次运行 reducer 会将先前元素的计算结果作为参数传入,最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T, currentIndex : number, array : T[\\]) => T | 是 | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为 array[0\\] 的值。 currentValue:当前元素的值。在第一次调用时,如果指定了 initialValue,则为 array[0\\] 的值,否则为 array[1\\]。 currentIndex:currentValue 在数组中的索引位置。在第一次调用时,如果指定了 initialValue 则为 0,否则为 1 array:调用了 reduce() 的数组本身。 |\n| initialValue | T | 是 | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue,则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue,则 accumulator 初始化为数组中的第一个值,并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下,如果数组为空(没有第一个值可以作为 accumulator 返回),则会抛出错误。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduce_3":{"name":"### reduce(callbackfn, initialValue)","description":"\r\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数,每一次运行 reducer 会将先前元素的计算结果作为参数传入,最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T, currentIndex : number) => T | 是 | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为 array[0\\] 的值。 currentValue:当前元素的值。在第一次调用时,如果指定了 initialValue,则为 array[0\\] 的值,否则为 array[1\\]。 currentIndex:currentValue 在数组中的索引位置。在第一次调用时,如果指定了 initialValue 则为 0,否则为 1 |\n| initialValue | T | 是 | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue,则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue,则 accumulator 初始化为数组中的第一个值,并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下,如果数组为空(没有第一个值可以作为 accumulator 返回),则会抛出错误。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduce_4":{"name":"### reduce(callbackfn, initialValue)","description":"\r\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数,每一次运行 reducer 会将先前元素的计算结果作为参数传入,最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T) => T | 是 | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为 array[0\\] 的值。 currentValue:当前元素的值。在第一次调用时,如果指定了 initialValue,则为 array[0\\] 的值,否则为 array[1\\]。 |\n| initialValue | T | 是 | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue,则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue,则 accumulator 初始化为数组中的第一个值,并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下,如果数组为空(没有第一个值可以作为 accumulator 返回),则会抛出错误。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduceRight":{"name":"### reduceRight(callbackfn)","description":"\r\nreduceRight() 方法对累加器(accumulator)和数组的每个值(按从右到左的顺序)应用一个函数,并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T, currentIndex : number, array : T[\\]) => T | 是 | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 currentIndex:正在处理的元素在数组中的索引。 array:调用了 reduceRight() 的数组本身。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduceRight_1":{"name":"### reduceRight(callbackfn)","description":"\r\nreduceRight() 方法对累加器(accumulator)和数组的每个值(按从右到左的顺序)应用一个函数,并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T, currentIndex : number) => T | 是 | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 currentIndex:正在处理的元素在数组中的索引。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduceRight_2":{"name":"### reduceRight(callbackfn)","description":"\r\nreduceRight() 方法对累加器(accumulator)和数组的每个值(按从右到左的顺序)应用一个函数,并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T) => T | 是 | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduceRight_3":{"name":"### reduceRight(callbackfn, initialValue)","description":"\r\nreduceRight() 方法对累加器(accumulator)和数组的每个值(按从右到左的顺序)应用一个函数,并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T, currentIndex : number, array : T[\\]) => T | 是 | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 currentIndex:正在处理的元素在数组中的索引。 array:调用了 reduceRight() 的数组本身。 |\n| initialValue | T | 是 | 首次调用 callbackFn 时累加器的值。如果不提供初始值,则将使用数组中的最后一个元素,并在迭代时跳过它。没有初始值的情况下,在空数组上调用 reduceRight() 会产生 TypeError。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduceRight_4":{"name":"### reduceRight(callbackfn, initialValue)","description":"\r\nreduceRight() 方法对累加器(accumulator)和数组的每个值(按从右到左的顺序)应用一个函数,并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T, currentIndex : number) => T | 是 | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 currentIndex:正在处理的元素在数组中的索引。 |\n| initialValue | T | 是 | 首次调用 callbackFn 时累加器的值。如果不提供初始值,则将使用数组中的最后一个元素,并在迭代时跳过它。没有初始值的情况下,在空数组上调用 reduceRight() 会产生 TypeError。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reduceRight_5":{"name":"### reduceRight(callbackfn, initialValue)","description":"\r\nreduceRight() 方法对累加器(accumulator)和数组的每个值(按从右到左的顺序)应用一个函数,并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (previousValue : T, currentValue : T) => T | 是 | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用,返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数: previousValue:上一次调用 callbackFn 的结果。在第一次调用时,如果指定了 initialValue 则为指定的值,否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 |\n| initialValue | T | 是 | 首次调用 callbackFn 时累加器的值。如果不提供初始值,则将使用数组中的最后一个元素,并在迭代时跳过它。没有初始值的情况下,在空数组上调用 reduceRight() 会产生 TypeError。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"find":{"name":"### find(predicate, thisArg?)","description":"\r\nfind() 方法返回数组中满足提供的测试函数的第一个元素的值。否则返回 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number, obj : T[\\]) => value is S | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值来表示已经找到了匹配的元素。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| S \\| null | 数组中第一个满足所提供测试函数的元素的值,否则返回 null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"find_1":{"name":"### find(predicate, thisArg?)","description":"\r\nfind() 方法返回数组中满足提供的测试函数的第一个元素的值。否则返回 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number) => value is S | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值来表示已经找到了匹配的元素。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| S \\| null | 数组中第一个满足所提供测试函数的元素的值,否则返回 null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"find_2":{"name":"### find(predicate, thisArg?)","description":"\r\nfind() 方法返回数组中满足提供的测试函数的第一个元素的值。否则返回 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T) => value is S | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值来表示已经找到了匹配的元素。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| S \\| null | 数组中第一个满足所提供测试函数的元素的值,否则返回 null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"findIndex":{"name":"### findIndex(predicate, thisArg?)","description":"\r\nfindIndex() 方法返回数组中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number, obj : T[\\]) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以指示已找到匹配元素,否则返回一个假值。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 数组中第一个满足测试条件的元素的索引。否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"findIndex_1":{"name":"### findIndex(predicate, thisArg?)","description":"\r\nfindIndex() 方法返回数组中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T, index : number) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以指示已找到匹配元素,否则返回一个假值。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 数组中第一个满足测试条件的元素的索引。否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"findIndex_2":{"name":"### findIndex(predicate, thisArg?)","description":"\r\nfindIndex() 方法返回数组中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| predicate | (value : T) => unknown | 是 | 为数组中的每个元素执行的函数。它应该返回一个真值以指示已找到匹配元素,否则返回一个假值。 |\n| thisArg | any | 否 | 执行 callbackFn 时用作 this 的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 数组中第一个满足测试条件的元素的索引。否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"fill":{"name":"### fill(value, start?, end?)","description":"\r\nfill() 方法用一个固定值填充一个数组中从起始索引(默认为 0)到终止索引(默认为 array.length)内的全部元素。它返回修改后的数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | T | 是 | 用来填充数组元素的值。注意所有数组中的元素都将是这个确定的值:如果 value 是个对象,那么数组的每一项都会引用这个元素。 |\n| start | number | 否 | 基于零的索引,从此开始填充,转换为整数。 |\n| end | number | 否 | 基于零的索引,在此结束填充,转换为整数。fill() 填充到但不包含 end 索引。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| this | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"copyWithin":{"name":"### copyWithin(target, start?, end?)","description":"\r\ncopyWithin() 方法浅复制数组的一部分到同一数组中的另一个位置,并返回它,不会改变原数组的长度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| target | number | 是 | 序列开始替换的目标位置,以 0 为起始的下标表示,且将被转换为整数 |\n| start | number | 否 | 要复制的元素序列的起始位置,以 0 为起始的下标表示,且将被转换为整数 |\n| end | number | 否 | 要复制的元素序列的结束位置,以 0 为起始的下标表示,且将被转换为整数。copyWithin 将会拷贝到该位置,但不包括 end 这个位置的元素。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| this | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"includes":{"name":"### includes(searchElement, fromIndex?)","description":"\r\nincludes() 方法用来判断一个数组是否包含一个指定的值,根据情况,如果包含则返回 true,否则返回 false。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchElement | any | 是 | 需要查找的值。 |\n| fromIndex | number | 否 | 可选。开始搜索的索引(从零开始),会转换为整数。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 一个布尔值,如果在数组中(或者在 fromIndex 所指示的数组部分中,如果指定 fromIndex 的话)找到 searchElement 值,则该值为 true。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"isArray":{"name":"### isArray(arg)","description":"\r\nArray.isArray() 静态方法用于确定传递的值是否是一个 Array。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| arg | any | 是 | 需要检测的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| arg is any[\\] | 如果 value 是 Array,则为 true;否则为 false。如果 value 是 TypedArray 实例,则总是返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"}},"Map":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Map)","size":{"name":"### size","description":"","param":"","returnValue":"**返回值** \n\nMap 对象的成员数量。","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"clear":{"name":"### clear()","description":"\r\n移除 Map 对象中的所有元素。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"delete":{"name":"### delete(key)","description":"\r\n用于移除 Map 对象中指定的元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | K | 是 | 要从 Map 对象中删除的元素的键。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果 Map 对象中的元素存在并已被移除,则为 true;如果该元素不存在,则为 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"forEach":{"name":"### forEach(callbackfn, thisArg?)","description":"\r\n按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : V, key : K, map : Map\\) => void | 是 | Map 中每个元素所要执行的函数。它具有如下的参数: value: 每个迭代的值。 key: 每个迭代的键。 map: 正在迭代的 Map。 |\n| thisArg | any | 否 | 在 callbackfn 执行中使用的 this 的值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"forEach_1":{"name":"### forEach(callbackfn, thisArg?)","description":"\r\n按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : V, key : K) => void | 是 | Map 中每个元素所要执行的函数。它具有如下的参数: value: 每个迭代的值。 key: 每个迭代的键。 |\n| thisArg | any | 否 | 在 callbackfn 执行中使用的 this 的值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"forEach_2":{"name":"### forEach(callbackfn, thisArg?)","description":"\r\n按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : V) => void | 是 | Map 中每个元素所要执行的函数。它具有如下的参数: value: 每个迭代的值。 |\n| thisArg | any | 否 | 在 callbackfn 执行中使用的 this 的值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"get":{"name":"### get(key)","description":"\r\n从 Map 对象返回指定的元素。如果与所提供的键相关联的值是一个对象,那么你将获得该对象的引用,对该对象所做的任何更改都会有效地在 Map 对象中修改它。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | K | 是 | 从 Map 对象返回的元素的键。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| V \\| null | 与指定键相关联的元素,如果键在 Map 对象中找不到,则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"has":{"name":"### has(key)","description":"\r\n返回一个布尔值,指示具有指定键的元素是否存在。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | K | 是 | 用于测试 Map 对象中是否存在的元素的键。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果 Map 对象中存在具有指定键的元素,则返回 true;否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"set":{"name":"### set(key, value)","description":"\r\n为 Map 对象添加或更新一个指定了键(key)和值(value)的(新)键值对。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | K | 是 | 要添加到 Map 对象的元素的键。该值可以是任何数据类型(任何原始值或任何类型的对象)。 |\n| value | V | 是 | 要添加到 Map 对象的元素的值。该值可以是任何数据类型(任何原始值或任何类型的对象)。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| this | Map 对象 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"}},"Set":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Set)","size":{"name":"### size","description":"\r\n返回 Set 对象中(唯一的)元素的个数。","param":"","returnValue":"**返回值** \n\n返回 Set 对象中(唯一的)元素的个数。","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"prop"},"add":{"name":"### add(value)","description":"\r\n如果 Set 对象中没有具有相同值的元素,则 add() 方法将插入一个具有指定值的新元素到 Set 对象中。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | T | 是 | 要添加到 Set 对象的元素的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| this | Set 对象本身。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"clear":{"name":"### clear()","description":"\r\n移除 Set 对象中所有元素。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"delete":{"name":"### delete(value)","description":"\r\n从 Set 对象中删除指定的值(如果该值在 Set 中)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | T | 是 | 要从 Set 中移除的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 成功删除返回 true,否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 3.9 | 4.0 |\n","itemType":"method"},"forEach":{"name":"### forEach(callbackfn, thisArg?)","description":"\r\n对 Set 对象中的每个值按插入顺序执行一次提供的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : T, value2 : T, set : Set\\) => void | 是 | 为集合中每个元素执行的回调函数,该函数接收三个参数:value、key: Set 中正在处理的当前元素。因为 Set 中没有键,所以 value 会被共同传递给这两个参数。set: 调用 forEach() 的 Set 对象。 |\n| thisArg | any | 否 | 值在执行 callbackFn 时作为 this 使用。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"forEach_1":{"name":"### forEach(callbackfn, thisArg?)","description":"\r\n对 Set 对象中的每个值按插入顺序执行一次提供的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : T, value2 : T) => void | 是 | 为集合中每个元素执行的回调函数,该函数接收两个参数:value、key。 |\n| thisArg | any | 否 | 值在执行 callbackFn 时作为 this 使用。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"forEach_2":{"name":"### forEach(callbackfn, thisArg?)","description":"\r\n对 Set 对象中的每个值按插入顺序执行一次提供的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callbackfn | (value : T) => void | 是 | 为集合中每个元素执行的回调函数,该函数接收一个参数:value。 |\n| thisArg | any | 否 | 值在执行 callbackFn 时作为 this 使用。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"has":{"name":"### has(value)","description":"\r\n返回一个布尔值来指示对应的值是否存在于 Set 对象中。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | T | 是 | 要测试是否存在于 Set 对象中的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果 Set 对象中存在具有指定值的元素,则返回 true;否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"}},"Promise":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Promise)","Constructor":{"name":"### Constructor(fn)","description":"\r\n创建一个新的 Promise 对象。该构造函数主要用于封装还没有添加 promise 支持的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| fn | ( resolve: (value: T) => void, reject: (reason: any \\| null) => void ) => void | 是 | 在构造函数中执行的 function。 |","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"Constructor_1":{"name":"### Constructor(fn)","description":"\r\n创建一个新的 Promise 对象。该构造函数主要用于封装还没有添加 promise 支持的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| fn | (resolve: (value: T) => void) => void | 是 | 在构造函数中执行的 function。 |","returnValue":"","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"then":{"name":"### then()","description":"\r\n将一个兑现处理器和拒绝处理器附加到 Promise 上,并返回一个新的 Promise,解决为调用处理器得到的返回值,或者如果 Promise 没有被处理(即相关处理器 onFulfilled 或 onRejected 不是函数),则以原始敲定值解决。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"then_1":{"name":"### then(onFulfilled, onRejected?)","description":"\r\n将一个兑现处理器和拒绝处理器附加到 Promise 上,并返回一个新的 Promise,解决为调用处理器得到的返回值,或者如果 Promise 没有被处理(即相关处理器 onFulfilled 或 onRejected 不是函数),则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onFulfilled | () => R | 是 | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | Function \\| null | 否 | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"then_2":{"name":"### then(onFulfilled, onRejected?)","description":"\r\n将一个兑现处理器和拒绝处理器附加到 Promise 上,并返回一个新的 Promise,解决为调用处理器得到的返回值,或者如果 Promise 没有被处理(即相关处理器 onFulfilled 或 onRejected 不是函数),则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onFulfilled | () => Promise\\ | 是 | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | Function \\| null | 否 | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"then_3":{"name":"### then(onFulfilled, onRejected?)","description":"\r\n将一个兑现处理器和拒绝处理器附加到 Promise 上,并返回一个新的 Promise,解决为调用处理器得到的返回值,或者如果 Promise 没有被处理(即相关处理器 onFulfilled 或 onRejected 不是函数),则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onFulfilled | (res: T) => R | 是 | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | Function \\| null | 否 | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"then_4":{"name":"### then(onFulfilled, onRejected?)","description":"\r\n将一个兑现处理器和拒绝处理器附加到 Promise 上,并返回一个新的 Promise,解决为调用处理器得到的返回值,或者如果 Promise 没有被处理(即相关处理器 onFulfilled 或 onRejected 不是函数),则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onFulfilled | (res: T) => Promise\\ | 是 | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | Function \\| null | 否 | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"catch":{"name":"### catch()","description":"\r\n将一个拒绝处理回调函数附加到 Promise 上,并返回一个新的 Promise,如果回调被调用,则解决为回调的返回值,如果 Promise 被兑现,解决为其原始兑现值。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"catch_1":{"name":"### catch(onRejected)","description":"\r\n将一个拒绝处理回调函数附加到 Promise 上,并返回一个新的 Promise,如果回调被调用,则解决为回调的返回值,如果 Promise 被兑现,解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onRejected | () => R | 是 | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"catch_2":{"name":"### catch(onRejected)","description":"\r\n将一个拒绝处理回调函数附加到 Promise 上,并返回一个新的 Promise,如果回调被调用,则解决为回调的返回值,如果 Promise 被兑现,解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onRejected | () => Promise\\ | 是 | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"catch_3":{"name":"### catch(onRejected)","description":"\r\n将一个拒绝处理回调函数附加到 Promise 上,并返回一个新的 Promise,如果回调被调用,则解决为回调的返回值,如果 Promise 被兑现,解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onRejected | (res: any \\| null) => R | 是 | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"catch_4":{"name":"### catch(onRejected)","description":"\r\n将一个拒绝处理回调函数附加到 Promise 上,并返回一个新的 Promise,如果回调被调用,则解决为回调的返回值,如果 Promise 被兑现,解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onRejected | (res: any \\| null) => Promise\\ | 是 | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"finally":{"name":"### finally(callback)","description":"\r\n将一个处理器附加到 Promise 上,并返回一个新的 Promise,当原始 Promise 被解决时解决。无论 Promise 是否被兑现还是被拒绝,处理器都会在 Promise 敲定时被调用。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | Function | 是 | 一个当 promise 敲定时异步执行的函数。它的返回值将被忽略,除非返回一个被拒绝的 promise。调用该函数时不带任何参数。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"resolve":{"name":"### resolve()","description":"\r\n返回一个新的 Promise 对象,该对象以给定的值兑现。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"resolve_1":{"name":"### resolve(value)","description":"\r\n返回一个新的 Promise 对象,该对象以给定的值兑现。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | T \\| null | 是 | 一个兑现的值。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"resolve_2":{"name":"### resolve(value)","description":"\r\n返回一个新的 Promise 对象,该对象以给定的值兑现。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Promise\\ \\| null | 是 | 一个 Promise。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"reject":{"name":"### reject(value?)","description":"\r\n返回一个新的 Promise 对象,该对象以给定的原因拒绝。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | any \\| null | 否 | 一个拒绝的原因。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"all":{"name":"### all(arr)","description":"\r\n接受一个 Promise 可迭代对象作为输入,并返回单个 Promise。返回的 Promise 在所有输入的 Promise 都兑现时(包括传入的可迭代对象为空时)被兑现,其值为一个包含所有兑现值的数组。如果输入的任何 Promise 被拒绝,返回的 Promise 也会被拒绝,并返回第一个拒绝的原因。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| arr | Array\\> | 是 | 一个 Promise 数组。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\> | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"race":{"name":"### race(arr)","description":"\r\n接受一个 Promise 可迭代对象作为输入,并返回单个 Promise。返回的 Promise 与第一个敲定的 Promise 的最终状态保持一致。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| arr | Array\\> | 是 | 一个 Promise 数组。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"any":{"name":"### any(arr)","description":"\r\n接受一个 Promise 可迭代对象作为输入,并返回单个 Promise。返回的 Promise 在任何输入的 Promise 兑现时兑现,其值为第一个兑现的值。如果所有输入的 Promise 都被拒绝(包括传入的可迭代对象为空时),返回的 Promise 将以带有一个包含拒绝原因的数组的 AggregateError 拒绝。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| arr | Array\\> | 是 | 一个 Promise 数组。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"allSettled":{"name":"### allSettled(arr)","description":"\r\n接受一个 Promise 可迭代对象作为输入,并返回单个 Promise。返回的 Promise 在所有输入的 Promise 都敲定时兑现(包括传入的可迭代对象为空时),其值为一个描述每个 Promise 结果的对象数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| arr | Array\\> | 是 | 一个 Promise 数组。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\>> | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"}},"UTSJSONObject":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.UTSJSONObject)","get":{"name":"### get(key)","description":"\r\n获取一个 属性,返回类型是any 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| any\\|null | 如果属性存在返回结果,不存在返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"set":{"name":"### set(key, value)","description":"\r\n获取一个 属性,返回类型是any 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |\n| value | any | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| void | 如果属性存在返回结果,不存在返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getAny":{"name":"### getAny(key)","description":"\r\n获取一个 属性,返回类型是any 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| any\\|null | 如果属性存在返回结果,不存在返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getBoolean":{"name":"### getBoolean(key)","description":"\r\n获取一个Boolean属性,返回类型是Boolean 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean\\|null | 如果属性名存在,且类型为Boolean返回对应的结果,不存在返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getNumber":{"name":"### getNumber(key)","description":"\r\n获取一个number属性,返回类型是number 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number\\|null | 如果属性名存在,且类型为number返回对应的结果,不存在返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getString":{"name":"### getString(key)","description":"\r\n获取一个string属性,返回类型是string 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string\\|null | 如果属性名存在,且类型为string返回对应的结果,不存在返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getJSON":{"name":"### getJSON(key)","description":"\r\n获取一个UTSJSONObject属性,返回类型是UTSJSONObject 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UTSJSONObject\\|null | 如果属性名存在,且类型为UTSJSONObject返回对应的结果,不存在返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getArray":{"name":"### getArray(key)","description":"\r\n获取一个Array属性,返回类型是Array 或者 null, 数组元素类型由泛型T决定","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\\\|null | 如果属性名存在,且类型为Array返回对应的结果,不存在返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"getArray_1":{"name":"### getArray(key)","description":"\r\n获取一个Array属性,返回类型是Array 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\\\|null | 如果属性名存在,且类型为Array返回对应的结果,不存在返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"toMap":{"name":"### toMap()","description":"\r\n将当前 UTSJSONObject 实例转换为 Map 实例。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Map\\ | 返回 Map\\ 类型的 map | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"}},"Console":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Console)","debug":{"name":"### debug(data)","description":"\r\n在控制台打印 debug 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | (any \\| null)[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"error":{"name":"### error(data)","description":"\r\n在控制台打印 error 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | (any \\| null)[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"info":{"name":"### info(data)","description":"\r\n在控制台打印 info 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | (any \\| null)[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"log":{"name":"### log(data)","description":"\r\n在控制台打印 log 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | (any \\| null)[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"},"warn":{"name":"### warn(data)","description":"\r\n在控制台打印 warn 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | (any \\| null)[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method"}},"Global":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods)","parseInt":{"name":"### parseInt(string, radix?)","description":"\r\nparseInt(string, radix) 解析一个字符串并返回指定基数的十进制整数,radix 是 2-36 之间的整数,表示被解析字符串的基数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| string | string | 是 | 要被解析的值。字符串开头的空白符将会被忽略。(注意:只接收字符串类型的参数,其他类型将编译报错。) |\n| radix | number | 否 | 从 2 到 36 的整数,表示进制的基数。例如指定 16 表示被解析值是十六进制数。如果超出这个范围,将返回 NaN。假如指定 0 或未指定,基数将会根据字符串的值进行推算。注意,推算的结果不会永远是默认值 10! |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 从给定的字符串中解析出的一个整数,或者 NaN。当radix 小于 2 或大于 36,或第一个非空格字符不能转换为数字时返回 NAN。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.parseInt)"},"parseFloat":{"name":"### parseFloat(string)","description":"\r\nparseFloat() 函数解析一个参数(直接收字符串类型的参数,其他类型编译报错)并返回一个浮点数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| string | string | 是 | 需要被解析成为浮点数的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定值被解析成浮点数。如果给定值不能被转换成数值,则会返回 NaN。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.parseFloat)"},"isNaN":{"name":"### isNaN(number)","description":"\r\nisNaN() 函数用来确定一个值是否为NaN 。注:isNaN函数内包含一些非常有趣的规则;你也可以使用 ECMAScript 2015 中定义的 Number.isNaN() 来判断。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| number | number | 是 | 要被检测的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果给定值为 NaN则返回值为true;否则为false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.isNaN)"},"isFinite":{"name":"### isFinite(number)","description":"\r\nisFinite() 函数用来判断被传入的参数值是否为一个有限数值(finite number)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| number | number | 是 | 要被检测的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果参数是 NaN,正无穷大或者负无穷大,会返回false,其他返回 true。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.isFinite)"},"decodeURI":{"name":"### decodeURI(encodedURI)","description":"\r\ndecodeURI() 函数能解码由encodeURI 创建或其他流程得到的统一资源标识符(URI)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| encodedURI | string | 是 | 一个完整的编码过的 URI |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个给定编码统一资源标识符 (URI) 的未编码版本的新字符串, 当 encodedURI 包含无效字符序列时,会返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.decodeURI)"},"decodeURIComponent":{"name":"### decodeURIComponent(encodedURIComponent)","description":"\r\ndecodeURIComponent() 方法用于解码由 encodeURIComponent 方法或者其他类似方法编码的部分统一资源标识符(URI)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| encodedURIComponent | string | 是 | 编码后的部分 URI |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个解码后的统一资源标识符(URI)字符串,处理前的 URI 经过了给定格式的编码。当 encodedURI 包含无效字符序列时,会返回null. | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.decodeURIComponent)"},"encodeURI":{"name":"### encodeURI(uri)","description":"\r\nencodeURI() 函数通过将特定字符的每个实例替换为一个、两个、三或四转义序列来对统一资源标识符 (URI) 进行编码 (该字符的 UTF-8 编码仅为四转义序列) 由两个 \"代理\" 字符组成)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| uri | string | 是 | 一个完整的 URI。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新字符串,表示提供的字符串编码为统一资源标识符 (URI)。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.encodeURI)"},"encodeURIComponent":{"name":"### encodeURIComponent(uriComponent)","description":"\r\nencodeURIComponent() 函数通过将特定字符的每个实例替换成代表字符的 UTF-8 编码的一个、两个、三个或四个转义序列来编码 URI(只有由两个“代理”字符组成的字符会被编码为四个转义序列)。与 encodeURI() 相比,此函数会编码更多的字符,包括 URI 语法的一部分。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| uriComponent | string | 是 | 要被检测的 string 值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 原字串作为 URI 组成部分被被编码后的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.encodeURIComponent)"},"setInterval":{"name":"### setInterval(handler, timeout?, arguments)","description":"\r\nsetInterval() 方法重复调用一个函数或执行一个代码片段,在每次调用之间具有固定的时间间隔。\r\n它返回一个 interval ID,该 ID 唯一地标识时间间隔,因此你可以稍后通过调用 clearInterval() 来移除定时器。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| handler | string \\| Function | 是 | - |\n| timeout | number | 否 | - |\n| arguments | any[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.setInterval)"},"setTimeout":{"name":"### setTimeout(handler, timeout?, arguments)","description":"\r\n全局的 setTimeout() 方法设置一个定时器,一旦定时器到期,就会执行一个函数或指定的代码片段。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| handler | string \\| Function | 是 | - |\n| timeout | number | 否 | - |\n| arguments | any[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.setTimeout)"},"clearInterval":{"name":"### clearInterval(id)","description":"\r\nclearInterval() 方法可取消先前通过 setInterval() 设置的重复定时任务。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| id | number \\| undefined | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.clearInterval)"},"clearTimeout":{"name":"### clearTimeout(id)","description":"\r\nclearTimeout() 方法取消了先前通过调用setTimeout()建立的定时器","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| id | number \\| undefined | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.clearTimeout)"}},"Timers":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods)","parseInt":{"name":"### parseInt(string, radix?)","description":"\r\nparseInt(string, radix) 解析一个字符串并返回指定基数的十进制整数,radix 是 2-36 之间的整数,表示被解析字符串的基数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| string | string | 是 | 要被解析的值。字符串开头的空白符将会被忽略。(注意:只接收字符串类型的参数,其他类型将编译报错。) |\n| radix | number | 否 | 从 2 到 36 的整数,表示进制的基数。例如指定 16 表示被解析值是十六进制数。如果超出这个范围,将返回 NaN。假如指定 0 或未指定,基数将会根据字符串的值进行推算。注意,推算的结果不会永远是默认值 10! |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 从给定的字符串中解析出的一个整数,或者 NaN。当radix 小于 2 或大于 36,或第一个非空格字符不能转换为数字时返回 NAN。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.parseInt)"},"parseFloat":{"name":"### parseFloat(string)","description":"\r\nparseFloat() 函数解析一个参数(直接收字符串类型的参数,其他类型编译报错)并返回一个浮点数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| string | string | 是 | 需要被解析成为浮点数的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定值被解析成浮点数。如果给定值不能被转换成数值,则会返回 NaN。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.parseFloat)"},"isNaN":{"name":"### isNaN(number)","description":"\r\nisNaN() 函数用来确定一个值是否为NaN 。注:isNaN函数内包含一些非常有趣的规则;你也可以使用 ECMAScript 2015 中定义的 Number.isNaN() 来判断。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| number | number | 是 | 要被检测的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果给定值为 NaN则返回值为true;否则为false。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.isNaN)"},"isFinite":{"name":"### isFinite(number)","description":"\r\nisFinite() 函数用来判断被传入的参数值是否为一个有限数值(finite number)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| number | number | 是 | 要被检测的值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果参数是 NaN,正无穷大或者负无穷大,会返回false,其他返回 true。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.isFinite)"},"decodeURI":{"name":"### decodeURI(encodedURI)","description":"\r\ndecodeURI() 函数能解码由encodeURI 创建或其他流程得到的统一资源标识符(URI)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| encodedURI | string | 是 | 一个完整的编码过的 URI |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个给定编码统一资源标识符 (URI) 的未编码版本的新字符串, 当 encodedURI 包含无效字符序列时,会返回null | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.decodeURI)"},"decodeURIComponent":{"name":"### decodeURIComponent(encodedURIComponent)","description":"\r\ndecodeURIComponent() 方法用于解码由 encodeURIComponent 方法或者其他类似方法编码的部分统一资源标识符(URI)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| encodedURIComponent | string | 是 | 编码后的部分 URI |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个解码后的统一资源标识符(URI)字符串,处理前的 URI 经过了给定格式的编码。当 encodedURI 包含无效字符序列时,会返回null. | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.decodeURIComponent)"},"encodeURI":{"name":"### encodeURI(uri)","description":"\r\nencodeURI() 函数通过将特定字符的每个实例替换为一个、两个、三或四转义序列来对统一资源标识符 (URI) 进行编码 (该字符的 UTF-8 编码仅为四转义序列) 由两个 \"代理\" 字符组成)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| uri | string | 是 | 一个完整的 URI。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新字符串,表示提供的字符串编码为统一资源标识符 (URI)。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.encodeURI)"},"encodeURIComponent":{"name":"### encodeURIComponent(uriComponent)","description":"\r\nencodeURIComponent() 函数通过将特定字符的每个实例替换成代表字符的 UTF-8 编码的一个、两个、三个或四个转义序列来编码 URI(只有由两个“代理”字符组成的字符会被编码为四个转义序列)。与 encodeURI() 相比,此函数会编码更多的字符,包括 URI 语法的一部分。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| uriComponent | string | 是 | 要被检测的 string 值。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 原字串作为 URI 组成部分被被编码后的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.encodeURIComponent)"},"setInterval":{"name":"### setInterval(handler, timeout?, arguments)","description":"\r\nsetInterval() 方法重复调用一个函数或执行一个代码片段,在每次调用之间具有固定的时间间隔。\r\n它返回一个 interval ID,该 ID 唯一地标识时间间隔,因此你可以稍后通过调用 clearInterval() 来移除定时器。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| handler | string \\| Function | 是 | - |\n| timeout | number | 否 | - |\n| arguments | any[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.setInterval)"},"setTimeout":{"name":"### setTimeout(handler, timeout?, arguments)","description":"\r\n全局的 setTimeout() 方法设置一个定时器,一旦定时器到期,就会执行一个函数或指定的代码片段。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| handler | string \\| Function | 是 | - |\n| timeout | number | 否 | - |\n| arguments | any[\\] | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.setTimeout)"},"clearInterval":{"name":"### clearInterval(id)","description":"\r\nclearInterval() 方法可取消先前通过 setInterval() 设置的重复定时任务。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| id | number \\| undefined | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.clearInterval)"},"clearTimeout":{"name":"### clearTimeout(id)","description":"\r\nclearTimeout() 方法取消了先前通过调用setTimeout()建立的定时器","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| id | number \\| undefined | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.clearTimeout)"}},"UTSAndroid":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSAndroid)","onAppConfigChange":{"name":"### onAppConfigChange(callback)","description":"\r\n监听 App配置发生变化, 对应 android原生 onAppConfigChange","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | (res:UTSJSONObject)=>void | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"offAppConfigChange":{"name":"### offAppConfigChange(callback?)","description":"\r\nonAppConfigChange 对应的反注册函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | (res:UTSJSONObject)=>void | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"onAppTrimMemory":{"name":"### onAppTrimMemory(callback?)","description":"\r\n注册监听 App 内存不足时的系统回调函数 对应原生的API: onTrimMemory","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | (res:Number)=>void | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"offAppTrimMemory":{"name":"### offAppTrimMemory(callback?)","description":"\r\nonAppTrimMemory 对应的反注册函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | (res:Number)=>void | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"onAppActivityPause":{"name":"### onAppActivityPause(callback)","description":"\r\n注册监听 activity onPause事件","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ()=>void | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"offAppActivityPause":{"name":"### offAppActivityPause(callback?)","description":"\r\nonAppActivityPause 对应的反注册函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ()=>void | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"onAppActivityResume":{"name":"### onAppActivityResume(callback)","description":"\r\n注册监听 activity onResume事件","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ()=>void | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"offAppActivityResume":{"name":"### offAppActivityResume(callback?)","description":"\r\nonAppActivityResume 对应的反注册函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ()=>void | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"onAppActivityDestroy":{"name":"### onAppActivityDestroy(callback)","description":"\r\n注册监听 activity onDestroy事件","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ()=>void | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"offAppActivityDestroy":{"name":"### offAppActivityDestroy(callback?)","description":"\r\nonAppActivityDestroy 对应的反注册函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ()=>void | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"onAppActivityResult":{"name":"### onAppActivityResult(callback)","description":"\r\n注册监听 activity onAppActivityResult 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | (requestCode: Int, resultCode: Int, data: Intent?)=>void | 是 | 用于监听的响应函数 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"offAppActivityResult":{"name":"### offAppActivityResult(callback?)","description":"\r\nonAppActivityResult 对应的反注册函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | (requestCode: Int, resultCode: Int, data: Intent?)=>void | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"onAppActivityBack":{"name":"### onAppActivityBack(callback)","description":"\r\n注册监听 activity onAppActivityBack 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ()=>void | 是 | 用于监听的响应函数 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"offAppActivityBack":{"name":"### offAppActivityBack(callback?)","description":"\r\n取消注册监听 activity onAppActivityBack 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ()=>void | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getAppContext":{"name":"### getAppContext()","description":"\r\n获取当前应用Application上下文,对应android平台 Context.getApplicationContext 函数实现","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Context \\| null | 当前应用程序 上下文实例对象 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getUniActivity":{"name":"### getUniActivity()","description":"\r\n获取当前应用 栈顶的 Activity实例,对应android平台 getActivity 函数实现","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Activity \\| null | 当前应用栈顶的 Activity实例 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getTopPageActivity":{"name":"### getTopPageActivity()","description":"\r\n获取与当前页面绑定的activity对象,需要注意的是:当页面对象未与activity建立绑定关系时,可能为null","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Activity \\| null | 当前页面绑定的activity示例 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 4.0 | x | - |\n","itemType":"method"},"getResourcePath":{"name":"### getResourcePath(resourceName)","description":"\r\n获取H5资源文件的原生路径。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| resourceName | string | 是 | H5资源文件相对于工程的绝对路径, 如:“/static/logo.png” |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 该资源在原生目录下的路径 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | x | x | - |\n","itemType":"method"},"getJavaClass":{"name":"### getJavaClass(input)","description":"\r\n获取对象的jvm class实例","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| input | any | 是 | 任意不为空对象 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Class | 传入对象所对应的class实例 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 4.0 | x | - |\n","itemType":"method"},"getAppCachePath":{"name":"### getAppCachePath()","description":"\r\n获取app 临时目录。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string \\| null | 返回app临时目录路径。存放在该文件可能会在应用退出后被清理 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n","itemType":"method"},"exit":{"name":"### exit()","description":"\r\n退出当前应用","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getDispatcher":{"name":"### getDispatcher(threadName)","description":"\r\n获取一个任务分发器实例","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| threadName | string | 是 | 任务组名称,可能为:main: ui thread / dom: 仅uni-app x环境生效,uni-app 环境会自动切换到 ui / io : io thread 匿名线程 / '': 来源线程,如果来源线程不支持任务分发,则会在当前线程执行执行. 这个场景下要求第一个参数必须是线程环境 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| [UTSTaskDispatcher](#utstaskdispatcher-values) | \n\n\n\n##### UTSTaskDispatcher 的方法 @utstaskdispatcher-values \n\n##### async(action, param?) @async\n\r\n在当前任务分发器 异步执行任务\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| action | (action?: any) => void | 是 | - | 任务函数 |\n| param | any | 否 | - | 任务函数需要的参数 |\n\n\n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getAppId":{"name":"### getAppId()","description":"\r\n获取当前运行的app的AppId。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前运行的app的AppId。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getOsTheme":{"name":"### getOsTheme()","description":"\r\n获取当前系统主题样式","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 系统主题样式 \"dark\":暗色模式 \"light\":亮色模式 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"isUniMp":{"name":"### isUniMp()","description":"\r\n获取当前运行环境是否是unimp。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 是否是unimp。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getAppName":{"name":"### getAppName()","description":"\r\n获取manifest.json 中配置的应用名称","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用名称。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getAppVersion":{"name":"### getAppVersion()","description":"\r\n获取manifest.json 中配置的应用版本信息","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UTSJSONObject | 应用版本信息 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getInnerVersion":{"name":"### getInnerVersion()","description":"\r\n获取引擎版本号。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 引擎版本号。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"isUniAppX":{"name":"### isUniAppX()","description":"\r\n获取当前是否是uniapp x 环境","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | uniapp x 环境 true, uniapp 环境: false。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"rpx2px":{"name":"### rpx2px(rpx)","description":"\r\nrpx单位 转换为 逻辑像素px单位","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| rpx | number | 是 | - |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回对应的逻辑像素值 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"rpx2px_1":{"name":"### rpx2px(rpx)","description":"\r\n页面的rpx像素转换为页面的px像素","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| rpx | number | 是 | 待转换的rpx |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 转换后的px | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.95 | x | - |\n","itemType":"method"},"isPrivacyAgree":{"name":"### isPrivacyAgree()","description":"\r\n当前应用是否已取得用户同意隐私协议","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | true 用户已同意 false 用户未同意 | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","itemType":"method"},"setPrivacyAgree":{"name":"### setPrivacyAgree(state)","description":"\r\n设置当前应用是否已取得用户同意隐私协议","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| state | boolean | 是 | true 用户已同意 false 用户未同意 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","itemType":"method"},"resetPrivacyAgree":{"name":"### resetPrivacyAgree()","description":"\r\n重置当前应用至用户未同意隐私协议","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | - |\n","itemType":"method"},"requestSystemPermission":{"name":"### requestSystemPermission(context, requestPermission, success, fail)","description":"\r\n请求系统权限","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| context | Activity | 是 | - |\n| requestPermission | Array\\ | 是 | 期望请求的权限 |\n| success | (allRight:boolean, grantedList:Array\\)=>void | 是 | - |\n| fail | (doNotAskAgain:boolean, grantedList:Array\\)=>void | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"checkSystemPermissionGranted":{"name":"### checkSystemPermissionGranted(context, requestPermission)","description":"\r\n检查当前应用是否已经具备指定权限","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| context | Activity | 是 | - |\n| requestPermission | Array\\ | 是 | 期望具备的权限 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 请求的权限列表中是否已经具备 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"gotoSystemPermissionActivity":{"name":"### gotoSystemPermissionActivity(context, requestPermission)","description":"\r\n跳转至系统权限手动设备列表","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| context | Activity | 是 | - |\n| requestPermission | Array\\ | 是 | 期望请求的权限 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"getSystemPermissionDenied":{"name":"### getSystemPermissionDenied(context, requestPermission)","description":"\r\n获取当前应用不具备的权限列表","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| context | Activity | 是 | - |\n| requestPermission | Array\\ | 是 | 期望请求的权限 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\ | 请求的权限列表中已经被禁用的部分 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9 | x | - |\n","itemType":"method"},"devicePX2px":{"name":"### devicePX2px(devicePX)","description":"\r\n物理像素转换为页面的px像素","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| devicePX | number | 是 | 待转换的物理像素 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 转换后的页面px | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.95 | x | - |\n","itemType":"method"},"convert2AbsFullPath":{"name":"### convert2AbsFullPath(inputPath)","description":"\r\n将文件的项目相对地址转换为 运行期对应的绝对地址\r\neg.\r\n 'static/logo.png' -> '/storage/sdcard/0/apps/com.xxxx/files/logo.png'\r\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| inputPath | string | 是 | 待转换的资源相对路径 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 转换后文件绝对路径 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.9x | x | - |\n","itemType":"method"},"getFileProviderUri":{"name":"### getFileProviderUri(file)","description":"\r\n将应用的私有文件 通过内置的FileProvider转换为外部应用可以访问的Uri\r\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| file | File | 是 | 待转换的私有文件 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Uri | 转换后的Uri | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| 4.4 | 3.99 | x | - |\n","itemType":"method"}},"UTSiOS":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSiOS)","getCurrentViewController":{"name":"### getCurrentViewController()","description":"\r\n获取当前 app 显示的 UIViewController。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UIViewController | 当前 app 显示的 UIViewController | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getKeyWindow":{"name":"### getKeyWindow()","description":"\r\n获取当前app的keyWindow。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UIWindow | 当前app的keyWindow. | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"colorWithString":{"name":"### colorWithString(value)","description":"\r\n获取指定的颜色。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | string | 是 | 需要转换的代表色值的字符串,支持一下格式:精简写法的十六进制 如:#f00,十六进制 如:#ff0000,RGB 如:rgb(255, 0, 0),RGBA 如:rgba(255, 0, 0, 0.5),色值关键字,如: red |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UIColor | UIColor 实例对象 注:如转换失败 默认会返回 黑色 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getResourcePath":{"name":"### getResourcePath(resourceName)","description":"\r\n获取H5资源文件的原生路径。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| resourceName | string | 是 | H5资源文件相对于工程的绝对路径, 如:“/static/logo.png” |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 该资源在原生目录下的路径 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"isSimulator":{"name":"### isSimulator()","description":"\r\n是否是模拟器。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 当前是模拟器 true, 当前是真机:false | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getDeviceId":{"name":"### getDeviceId()","description":"\r\n获取设备 deviceId。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前设备的 deviceId | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getModel":{"name":"### getModel()","description":"\r\n获取设备型号。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getUserAgent":{"name":"### getUserAgent()","description":"\r\n获取当前应用的 UserAgent。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前应用的 UserAgent。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getAppId":{"name":"### getAppId()","description":"\n获取当前运行的app的AppId。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前运行的app的AppId。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getDataPath":{"name":"### getDataPath()","description":"\n获取当前运行app的dataPath","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前运行app的dataPath。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"isUniMp":{"name":"### isUniMp()","description":"\n获取当前运行环境是否是unimp。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 是否是unimp。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getAppName":{"name":"### getAppName()","description":"\n获取manifest.json 中配置的应用名称","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用名称。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getAppVersion":{"name":"### getAppVersion()","description":"\n获取manifest.json 中配置的应用版本名称。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用版本名称。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getAppVersionCode":{"name":"### getAppVersionCode()","description":"\n获取manifest.json 中配置的应用版本号。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用版本号。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getOsLanguage":{"name":"### getOsLanguage()","description":"\n获取操作系统设置的语言。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | os language。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getAppWgtVersion":{"name":"### getAppWgtVersion()","description":"\n获取应用资源(wgt)的版本名称。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用资源(wgt)的版本名称。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getHostLanguage":{"name":"### getHostLanguage()","description":"\n获取小程序宿主语言。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 小程序宿主语言。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getHostVersion":{"name":"### getHostVersion()","description":"\n获取小程序宿主版本。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 小程序宿主版本。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getHostName":{"name":"### getHostName()","description":"\n获取小程序宿主名称。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 小程序宿主名称。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getHostPackageName":{"name":"### getHostPackageName()","description":"\n获取小程序宿主包名。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 小程序宿主包名。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getHostTheme":{"name":"### getHostTheme()","description":"\n获取系统当前主题,取值为light或dark。微信小程序全局配置\"darkmode\":true时才能获取,否则为 undefined (不支持小游戏)。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 系统当前主题。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getInnerVersion":{"name":"### getInnerVersion()","description":"\n获取引擎版本号。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 引擎版本号。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"getSystemSetting":{"name":"### getSystemSetting()","description":"\n获取系统设置信息。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Map\\ | 系统设置信息。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"isBaseIpa":{"name":"### isBaseIpa()","description":"\n获取当前是否是基座环境。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 基座环境 true, 线上环境: false。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"}},"UTSiOSHookProxy":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSiOSHookProxy)","onCreate":{"name":"### onCreate()","description":"\r\nuts 插件创建时的回调。\n此回调的准确时机对应于 OC 类的 load() 函数调用时机。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"applicationDidFinishLaunchingWithOptions":{"name":"### applicationDidFinishLaunchingWithOptions(application?, launchOptions?)","description":"\r\n应用正常启动时 (不包括已在后台转到前台的情况)的回调函数。\n可以在此回调函数做一些初始化操作,比如初始依赖的SDK等。注意:不要在此回调函数里做耗时操作,以免影响 app 的启动速度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| application | UIApplication | 否 | App 的 UIApplicationDelegate 对象。 |\n| launchOptions | Map\\ | 否 | 启动参数。默认值为 null (用户通过点击 push 通知启动应用时,该参数内会包含通知的信息) |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 返回一个 boolean 值,正常返回true。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"didRegisterForRemoteNotifications":{"name":"### didRegisterForRemoteNotifications(deviceToken?)","description":"\r\n远程通知注册成功时的回调函数。\n可以在此函数里将 deviceToken 发送给服务端。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| deviceToken | Data | 否 | 设备的推送令牌 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"didFailToRegisterForRemoteNotifications":{"name":"### didFailToRegisterForRemoteNotifications(error?)","description":"\r\n远程通知注册失败时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| error | NSError | 否 | 失败的原因。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"didReceiveRemoteNotification":{"name":"### didReceiveRemoteNotification(userInfo?)","description":"\r\n应用收到远程通知时的回调函数。\n当应用在前台运行中,收到远程通知时(不会弹出系统通知界面),会回调这个方法;当应用在后台状态时,点击push消息启动应用,也会回调这个方法;当应用完全没有启动时,点击push消息启动应用,就不会回调这个方法。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| userInfo | Map\\ | 否 | 收到的远程通知信息。 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"didReceiveLocalNotification":{"name":"### didReceiveLocalNotification(notification?)","description":"\r\n应用收到本地通知时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| notification | UILocalNotification | 否 | 接收到的本地通知 |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"applicationHandleOpenURL":{"name":"### applicationHandleOpenURL(application?, url?)","description":"\r\n通过 url scheme 方式唤起 app 时的回调函数。(iOS9 之前的系统回调此方法,iOS9 之后的系统请使用 applicationOpenURLOptions)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| application | UIApplication | 否 | App 的 UIApplicationDelegate 对象。 |\n| url | URL | 否 | 要打开的URL资源。该资源可以是网络资源或文件。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果成功处理请求,则为true;如果尝试打开URL资源失败,则为false。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"applicationOpenURLOptions":{"name":"### applicationOpenURLOptions(app?, url?, options?)","description":"\r\n通过 url scheme 方式唤起 app 时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| app | UIApplication | 否 | - |\n| url | URL | 否 | 要打开的URL资源。该资源可以是网络资源或文件。 |\n| options | Map\\ | 否 | URL处理选项的字典, 默认值为 null 。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果成功处理请求,则为true;如果尝试打开URL资源失败,则为false。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"applicationWillResignActive":{"name":"### applicationWillResignActive(application?)","description":"\n当应用从活动状态主动变为非活动状态的时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| application | UIApplication | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"applicationDidBecomeActive":{"name":"### applicationDidBecomeActive(application?)","description":"\n应用完全激活时的回调函数。\n应用程序冷启动或者从后台转到前台后都会完全激活应用程序。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| application | UIApplication | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"applicationDidEnterBackground":{"name":"### applicationDidEnterBackground(application?)","description":"\n应用程序进入后台时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| application | UIApplication | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"applicationWillEnterForeground":{"name":"### applicationWillEnterForeground(application?)","description":"\n当应用在后台状态,将要进入到前台运行时的回调函数。\n应用程序冷启动时不会回调此方法。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| application | UIApplication | 否 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"applicationMain":{"name":"### applicationMain(argc, argv)","description":"\n应用程序的 main 函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| argc | Int32 | 是 | - |\n| argv | UnsafeMutablePointer\\ \\| null> | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"},"applicationContinueUserActivityRestorationHandler":{"name":"### applicationContinueUserActivityRestorationHandler(application?, userActivity?, restorationHandler?)","description":"\n当应用程序接收到与用户活动相关的数据时调用此方法,例如,当用户使用 Universal Link 唤起应用时。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| application | UIApplication | 否 | App 的 UIApplicationDelegate 对象。 |\n| userActivity | NSUserActivity | 否 | 包含与用户正在执行的任务相关联的数据的活动对象。使用这些数据来继续用户在iOS应用中的活动。 |\n| restorationHandler | ((res ?: [any\\]) => void) | 否 | 需要执行的回调,该回调是可选的,默认值为 null。 |","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | true表示你的应用处理了这个活动,false表示让iOS知道你的应用没有处理这个活动。 | \n","compatibility":"**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | - |\n","itemType":"method"}},"UTSAndroidHookProxy":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSAndroidHookProxy)","onCreate":{"name":"### onCreate(application)","description":"\r\nuts 插件创建时的回调。\r\n对应原生 Application onCreate 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| application | Application | 是 | - |","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | x | - |\n","itemType":"method"}}}
\ No newline at end of file
+{
+ "String": {
+ "tutorial": "\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.String)",
+ "length": {
+ "name": "### length",
+ "description": "\r\n返回字符串的 UTF-16 码元长度。",
+ "param": "",
+ "returnValue": "",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "prop"
+ },
+ "toString": {
+ "name": "### toString()",
+ "description": "\r\n返回一个字符串,表示指定的字符串。",
+ "param": "",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | String 包装对象的字符串值。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "charAt": {
+ "name": "### charAt(pos)",
+ "description": "\r\n返回一个由给定索引处的单个 UTF-16 码元构成的新字符串。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| pos | number | 是 | 要返回的字符的索引,从零开始。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个字符串,该字符串表示指定 index 处的字符(恰好是一个 UTF-16 码元)。如果 index 超出了 0 – str.length - 1 的范围,charAt() 将返回一个空字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "charCodeAt": {
+ "name": "### charCodeAt(index)",
+ "description": "\r\n返回 0 到 65535 之间的整数,表示给定索引处的 UTF-16 代码单元",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | 一个大于等于 0,小于字符串长度的整数。如果不是一个数值,则默认为 0。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 指定 index 处字符的 UTF-16 代码单元值的一个数字;如果 index 超出范围,charCodeAt() 返回 NaN。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "concat": {
+ "name": "### concat(...strings)",
+ "description": "\r\n将字符串参数连接到调用的字符串,并返回一个新的字符串。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| strings | string[\\] | 否 | T要连接到 str 的一个或多个字符串。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个包含所提供的多个字符串文本组合的新字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "indexOf": {
+ "name": "### indexOf(searchString, position?)",
+ "description": "\r\n在字符串中搜索指定子字符串,并返回其第一次出现的位置索引。它可以接受一个可选的参数指定搜索的起始位置,如果找到了指定的子字符串,则返回的位置索引大于或等于指定的数字。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要搜索的子字符串。 |\n| position | number | 否 | 该方法返回指定子字符串在大于或等于 position 位置的第一次出现的索引,默认为 0。如果 position 大于调用字符串的长度,则该方法根本不搜索调用字符串。如果 position 小于零,该方法的行为就像 position 为 0 时一样。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 查找的字符串 searchValue 的第一次出现的索引,如果没有找到,则返回 -1。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "lastIndexOf": {
+ "name": "### lastIndexOf(searchString, position?)",
+ "description": "\r\n搜索该字符串并返回指定子字符串最后一次出现的索引。它可以接受一个可选的起始位置参数,并返回指定子字符串在小于或等于指定数字的索引中的最后一次出现的位置。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要搜索的子字符串。 |\n| position | number | 否 | 该方法返回指定子字符串在小于或等于 position 的位置中的最后一次出现的索引,默认为 +Infinity。如果 position 大于调用字符串的长度,则该方法将搜索整个字符串。如果 position 小于 0,则行为与 0 相同,即该方法只在索引 0 处查找指定的子字符串。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 如果找到了 searchString,则返回最后一次出现的索引,否则返回 -1。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "localeCompare": {
+ "name": "### localeCompare(that)",
+ "description": "\r\n返回一个数字,表示参考字符串在排序顺序中是在给定字符串之前、之后还是与之相同。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| that | string | 是 | 与 referenceStr 进行比较的字符串。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个数字表示 referenceStr 在排序中是否位于 compareString 的前面、后面或二者相同。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "match": {
+ "name": "### match(regexp)",
+ "description": "\r\nmatch() 方法检索字符串与正则表达式进行匹配的结果。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| regexp | string \\| RegExp | 是 | 一个正则表达式对象或者任何具有 Symbol.match 方法的对象。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| RegExpMatchArray \\| null | 一个 Array,其内容取决于是否存在全局(g)标志,如果没有匹配,则返回 null。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "replace": {
+ "name": "### replace(searchValue, replaceValue)",
+ "description": "\r\n返回一个由替换值(replacement)替换部分或所有的模式(pattern)匹配项后的新字符串。模式可以是一个字符串或者一个正则表达式。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchValue | string \\| RegExp | 是 | RegExp: 一个RegExp 对象或者其字面量。该正则所匹配的内容会被第二个参数的返回值替换掉。string: 一个将被 newSubStr 替换的 字符串。其被视为一整个字符串,而不是一个正则表达式。仅第一个匹配项会被替换。 |\n| replaceValue | string | 是 | 用于替换掉第一个参数在原字符串中的匹配部分的字符串。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个部分或全部匹配由替代模式所取代的新的字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "replace_1": {
+ "name": "### replace(searchValue, replacer)",
+ "description": "\r\n返回一个由替换值(replacement)替换部分或所有的模式(pattern)匹配项后的新字符串。模式可以是一个字符串或者一个正则表达式,替换值是一个每次匹配都要调用的回调函数。如果pattern是字符串,则仅替换第一个匹配项。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchValue | string \\| RegExp | 是 | RegExp: 一个RegExp 对象或者其字面量。该正则所匹配的内容会被第二个参数的返回值替换掉。string: 一个将被 newSubStr 替换的 字符串。其被视为一整个字符串,而不是一个正则表达式。仅第一个匹配项会被替换。 |\n| replacer | (substring : string, ...args : any[\\]) => string | 是 | 一个用来创建新子字符串的函数,该函数的返回值将替换掉第一个参数匹配到的结果。在iOS中replacer的第二个参数是字符串数组而非可变参数。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个部分或全部匹配由替代模式所取代的新的字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "search": {
+ "name": "### search(regexp)",
+ "description": "\r\nsearch() 方法执行正则表达式和 String 对象之间的一个搜索匹配。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| regexp | string \\| RegExp | 是 | 一个正则表达式(regular expression)对象。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 如果匹配成功,则 search() 返回正则表达式在字符串中首次匹配项的索引;否则,返回 -1。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "slice": {
+ "name": "### slice(start?, end?)",
+ "description": "\r\nslice() 方法提取某个字符串的一部分,并返回一个新的字符串,且不会改动原字符串。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| start | number | 否 | 可选。从该索引(以 0 为基数)处开始提取原字符串中的字符。如果值为负数,会被当做 strLength + beginIndex 看待,这里的strLength 是字符串的长度(例如,如果 beginIndex 是 -3 则看作是:strLength - 3) |\n| end | number | 否 | 可选。在该索引(以 0 为基数)处结束提取字符串。如果省略该参数,slice() 会一直提取到字符串末尾。如果该参数为负数,则被看作是 strLength + endIndex,这里的 strLength 就是字符串的长度 (例如,如果 endIndex 是 -3,则是,strLength - 3)。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个从原字符串中提取出来的新字符串 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "split": {
+ "name": "### split(separator, limit?)",
+ "description": "\r\nsplit() 方法接受一个模式,通过搜索模式将字符串分割成一个有序的子串列表,将这些子串放入一个数组,并返回该数组。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| separator | string \\| RegExp | 是 | 描述每个分割应该发生在哪里的模式。 |\n| limit | number | 否 | 一个非负整数,指定数组中包含的子字符串的数量限制。当提供此参数时,split 方法会在指定 separator 每次出现时分割该字符串,但在已经有 limit 个元素时停止分割。任何剩余的文本都不会包含在数组中。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string[\\] | 在给定字符串中出现 separator 的每一个点上进行分割而成的字符串数组。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "substring": {
+ "name": "### substring(start, end?)",
+ "description": "\r\n返回一个字符串在开始索引到结束索引之间的一个子集,或从开始索引直到字符串的末尾的一个子集。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| start | number | 是 | 要截取的第一个字符的索引,该索引位置的字符作为返回的字符串的首字母。 |\n| end | number | 否 | 可选。一个 0 到字符串长度之间的整数,以该数字为索引的字符不包含在截取的字符串内。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含给定字符串的指定部分的新字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "toLowerCase": {
+ "name": "### toLowerCase()",
+ "description": "toLowerCase() 会将调用该方法的字符串值转为小写形式,并返回。",
+ "param": "",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新的字符串,表示转换为小写的调用字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "toLocaleLowerCase": {
+ "name": "### toLocaleLowerCase(locales?)",
+ "description": "\r\n根据任何指定区域语言环境设置的大小写映射,返回调用字符串被转换为小写的格式。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| locales | string \\| string[\\] | 否 | 可选。指明要转换成小写格式的特定语言区域。如果以一个数组 Array 形式给出多个 locales, 最合适的地区将被选出来应用。默认的 locale 是主机环境的当前区域 (locale) 设置。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 根据任何特定于语言环境的案例映射规则将被调用字串转换成小写格式的一个新字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "toUpperCase": {
+ "name": "### toUpperCase()",
+ "description": "\r\n将调用该方法的字符串转为大写形式并返回(如果调用该方法的值不是字符串类型会被强制转换)。",
+ "param": "",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新的字符串,表示转换为大写的调用字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "toLocaleUpperCase": {
+ "name": "### toLocaleUpperCase(locales?)",
+ "description": "\r\n根据本地主机语言环境把字符串转换为大写格式,并返回转换后的字符串。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| locales | string \\| string[\\] | 否 | locales参数指示要用于根据任何特定于语言环境的大小写映射转换为大写的语言环境。如果Array中给出了多个区域设置,则使用最佳可用区域设置。默认语言环境是主机环境的当前语言环境。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 根据任何特定于语言环境的大小写映射,表示转换为大写的调用字符串的新字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "trim": {
+ "name": "### trim()",
+ "description": "\r\n从字符串的两端清除空格,返回一个新的字符串,而不修改原始字符串。此上下文中的空格是指所有的空白字符(空格、tab、不换行空格等)以及所有行终止符字符(如 LF、CR 等)。",
+ "param": "",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个表示 str 去掉了开头和结尾的空白字符后的新字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "substr": {
+ "name": "### substr(from, length?)",
+ "description": "\r\n返回一个字符串中从指定位置开始到指定字符数的字符。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| from | number | 是 | 开始提取字符的位置。如果为负值,则被看作 strLength + start,其中 strLength 为字符串的长度(例如,如果 start 为 -3,则被看作 strLength + (-3))。 |\n| length | number | 否 | 可选。提取的字符数。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个字符串中从指定位置开始到指定字符数的字符。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "valueOf": {
+ "name": "### valueOf()",
+ "description": "返回 String 对象的原始值",
+ "param": "",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | String 对象的原始值 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "padStart": {
+ "name": "### padStart(targetLength, padString?)",
+ "description": "\r\n用另一个字符串填充当前字符串(如果需要会重复填充),直到达到给定的长度。填充是从当前字符串的开头开始的。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| targetLength | number | 是 | 当前 str 填充后的长度。如果该值小于或等于 str.length,则会直接返回当前 str。 |\n| padString | string | 否 | 可选。用于填充当前 str 的字符串。如果 padString 太长,无法适应 targetLength,则会从末尾被截断。默认值为“ ”字符(U+0020)。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 在开头填充 padString 直到达到给定的 targetLength 所形成的 String。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "padEnd": {
+ "name": "### padEnd(targetLength, padString?)",
+ "description": "\r\n将当前字符串从末尾开始填充给定的字符串(如果需要会重复填充),直到达到给定的长度。填充是从当前字符串的末尾开始的。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| targetLength | number | 是 | 当前 str 填充后的长度。如果该值小于或等于 str.length,则会直接返回当前 str。 |\n| padString | string | 否 | 可选。用于填充当前 str 的字符串。如果 padString 太长,无法适应 targetLength,则会被截断。默认值为“ ”字符(U+0020)。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 在开头填充 padString 直到达到给定的 targetLength 所形成的 String。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "codePointAt": {
+ "name": "### codePointAt(pos)",
+ "description": "\r\n返回一个小于 1114112 (0x110000) 的非负整数 Number,它是 UTF-16 编码的代码点的代码点值,该代码点始于将此对象转换为字符串而产生的字符串中位置 pos 处的字符串元素。\r\n如果该位置没有元素,则结果未定义。\r\n如果有效的 UTF-16 代理项对不是从 pos 开始,则结果是 pos 处的代码单元。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| pos | number | 是 | 这个字符串中需要转码的元素的位置。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number \\| null | 返回值是在字符串中的给定索引的编码单元体现的数字,如果在索引处没找到元素则返回 null。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "includes": {
+ "name": "### includes(searchString, position?)",
+ "description": "\r\n如果 searchString 作为此对象转换为 String 的结果的子字符串出现在大于或等于position的一个或多个位置,则返回 true;否则,返回 false。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要在 str 中搜索的字符串。不能是正则表达式。 |\n| position | number | 否 | 在字符串中开始搜索 searchString 的位置。(默认为 0。) |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果在给定的字符串中找到了要搜索的字符串(包括 searchString 为空字符串的情况),则返回 true,否则返回 false。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "endsWith": {
+ "name": "### endsWith(searchString, endPosition?)",
+ "description": "\r\nendsWith() 方法用于判断一个字符串是否以指定字符串结尾,如果是则返回 true,否则返回 false。该方法区分大小写。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要搜索的作为结尾的字符串,不能是正则表达式。所有非正则表达式的值都会被强制转换为字符串。 |\n| endPosition | number | 否 | 可选,预期找到 searchString 的末尾位置(即 searchString 最后一个字符的索引加 1)。默认为 str.length。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果被检索字符串的末尾出现了指定的字符串(包括 searchString 为空字符串的情况),则返回 true;否则返回 false。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "normalize": {
+ "name": "### normalize(form)",
+ "description": "\r\nnormalize() 方法会按照指定的一种 Unicode 正规形式将当前字符串规范化。(如果该值不是字符串,则首先将其转换为一个字符串)。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| form | \"NFC\" \\| \"NFD\" \\| \"NFKC\" \\| \"NFKD\" | 是 | 四种 Unicode 正规形式(Unicode Normalization Form)\"NFC\"、\"NFD\"、\"NFKC\",或 \"NFKD\" 其中的一个,默认值为 \"NFC\"。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 含有给定字符串的 Unicode 规范化形式的字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "normalize_1": {
+ "name": "### normalize(form?)",
+ "description": "\r\nnormalize() 方法会按照指定的一种 Unicode 正规形式将当前字符串规范化。(如果该值不是字符串,则首先将其转换为一个字符串)。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| form | string | 否 | 四种 Unicode 正规形式(Unicode Normalization Form)\"NFC\"、\"NFD\"、\"NFKC\",或 \"NFKD\" 其中的一个,默认值为 \"NFC\"。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 含有给定字符串的 Unicode 规范化形式的字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "repeat": {
+ "name": "### repeat(count)",
+ "description": "\r\nrepeat() 构造并返回一个新字符串,该字符串包含被连接在一起的指定数量的字符串的副本。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| count | number | 是 | 介于 0 和 +Infinity 之间的整数。表示在新构造的字符串中重复了多少遍原字符串。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含指定字符串的指定数量副本的新字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "startsWith": {
+ "name": "### startsWith(searchString, position?)",
+ "description": "\r\nstartsWith() 方法用来判断当前字符串是否以另外一个给定的子字符串开头,并根据判断结果返回 true 或 false。这个方法区分大小写。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| searchString | string | 是 | 要搜索的子字符串。 |\n| position | number | 否 | 在 str 中搜索 searchString 的开始位置,默认值为 0。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果在字符串的开头找到了给定的字符则返回 true;否则返回 false。 | \n",
+ "compatibility": "**兼容性** \n\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "anchor": {
+ "name": "### anchor(name)",
+ "description": "\r\nanchor() 方法创建一个 \\ HTML 锚元素,被用作超文本靶标(hypertext target)。",
+ "param": "**参数** \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| name | string | 是 | 一个字符串,表示被创建的标签的 name 属性。 |",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含 \\ HTML 元素的一个字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "big": {
+ "name": "### big()",
+ "description": "\r\n创建一个使字符串显示大号字体的\\标签。",
+ "param": "",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 带有 \\标签的字符串。 | \n",
+ "compatibility": "**兼容性** \n\n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| x | x | x | 4.0 |\n",
+ "itemType": "method"
+ },
+ "blink": {
+ "name": "### blink()",
+ "description": "\r\nblink() 方法创建一个字符串,其在 \\ 中嵌入字符串,这使得字符串在旧版浏览器中闪烁。",
+ "param": "",
+ "returnValue": "**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含 \\