{ "getApp": { "name": "## getApp() @getapp", "description": "`getApp()` 函数用于获取当前应用实例，可通过应用实例调用 App.uvue methods 中定义的方法。", "compatibility": "### getApp HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| any |\n \n", "tutorial": "" }, "getCurrentPages": { "name": "## getCurrentPages() @getcurrentpages", "description": "`getCurrentPages()` 函数用于获取当前页面栈的实例，以数组形式按栈的顺序给出，数组中的元素为页面实例，第一个元素为首页，最后一个元素为当前页面。", "compatibility": "### getCurrentPages HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Array\\<[Page](#page-values)\\> |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| route | - |\n@| options | - |\n#### Page 的方法 @page-values \n\n#### $getPageStyle() @$getpagestyle\n获取当前页面样式 \\
包含 pages.json 页面下的 style 节点属性和根节点 globalStyle 属性\n##### $getPageStyle HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) |\n \n\n#### $setPageStyle(style) @$setpagestyle\n设置当前页面样式 \\
支持 pages.json 页面下的 style 节点属性和根节点 globalStyle 属性\n##### $setPageStyle HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| style | - | \n\n \n", "tutorial": "" }, "env": { "name": "## env", "description": "环境变量", "param": "### env 的属性值 @env-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| USER_DATA_PATH | - |\n| CACHE_PATH | - |\n| SANDBOX_PATH | - |\n", "compatibility": "", "returnValue": "", "tutorial": "" }, "$on": { "name": "## uni.$on(eventName, callback) @$on", "description": "监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。
", "compatibility": "### $on HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| eventName | - |\n| callback | - | \n", "returnValue": "", "tutorial": "" }, "$once": { "name": "## uni.$once(eventName, callback) @$once", "description": "监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器。
", "compatibility": "### $once HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| eventName | - |\n| callback | - | \n", "returnValue": "", "tutorial": "" }, "$off": { "name": "## uni.$off(eventName, callback?) @$off", "description": "移除自定义事件监听器。如果提供了事件名和回调，则只移除这个回调的监听器。
4.13+ 开始支持第二个参数为可选，如果仅提供事件名，则移除该事件的所有监听器。", "compatibility": "### $off HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| eventName | - |\n| callback | - | \n", "returnValue": "", "tutorial": "" }, "$emit": { "name": "## uni.$emit(eventName, args?) @$emit", "description": "触发自定义事件，附加的参数会传递给事件监听器。
", "compatibility": "### $emit HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| eventName | - |\n| args | - | \n", "returnValue": "", "tutorial": "" }, "base64ToArrayBuffer": { "name": "## uni.base64ToArrayBuffer(base64) @base64toarraybuffer", "description": "将 Base64 字符串转成 ArrayBuffer 对象
", "compatibility": "### base64ToArrayBuffer HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| base64 | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [ArrayBuffer](#arraybuffer-values) |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| byteLength | - |\n#### ArrayBuffer 的方法 @arraybuffer-values \n\n#### slice(begin, end?) @slice\nArrayBuffer 实例的 slice() 方法返回一个新的 ArrayBuffer 实例，其包含原 ArrayBuffer 实例中从 begin 开始（包含）到 end 结束（不含）的所有字节的副本。\n##### slice HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| begin | - |\n| end | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [ArrayBuffer](#arraybuffer-values) |\n \n \n", "tutorial": "" }, "arrayBufferToBase64": { "name": "## uni.arrayBufferToBase64(arrayBuffer) @arraybuffertobase64", "description": "将 ArrayBuffer 对象转成 Base64 字符串
", "compatibility": "### arrayBufferToBase64 HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| arrayBuffer | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| string |\n \n", "tutorial": "" }, "addInterceptor": { "name": "## uni.addInterceptor(name, interceptor) @addinterceptor", "description": "添加拦截器", "compatibility": "### addInterceptor HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| name | - |\n| interceptor | - | \n", "returnValue": "", "tutorial": "" }, "removeInterceptor": { "name": "## uni.removeInterceptor(name, interceptor?) @removeinterceptor", "description": "删除拦截器", "compatibility": "### removeInterceptor HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| name | - |\n| interceptor | - | \n", "returnValue": "", "tutorial": "" }, "getLaunchOptionsSync": { "name": "## uni.getLaunchOptionsSync() @getlaunchoptionssync", "description": "获取本次启动时的参数。返回值与App.onLaunch的回调参数一致
", "compatibility": "### getLaunchOptionsSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **OnLaunchOptions** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| path | - |\n@| appScheme | - |\n@| appLink | - | \n", "tutorial": "" }, "exit": { "name": "## uni.exit(options?) @exit", "description": "退出当前应用", "compatibility": "### exit HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ExitSuccess 的属性值 @exitsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n\n##### IExitError 的属性值 @iexiterror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "getProvider": { "name": "## uni.~~getProvider~~(options) @getprovider", "description": "获取服务供应商 **已废弃（仅为了兼容uni1的规范）**", "compatibility": "### getProvider HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| service | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetProviderSuccess 的属性值 @getprovidersuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| service | - |\n| provider | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "getPerformance": { "name": "## uni.getPerformance() @getperformance", "description": "返回一个Performance对象实例
", "compatibility": "### getPerformance HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [Performance](#performance-values) |\n\n#### Performance 的方法 @performance-values \n\n#### createObserver(callback) @createobserver\n创建全局性能事件监听器\n##### createObserver HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### PerformanceObserverEntryList 的方法 @performanceobserverentrylist-values \n\n###### getEntries() @getentries\n该方法返回当前列表中的所有性能数据\n###### getEntries HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Array\\<**PerformanceEntry**\\> |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| entryType | - |\n@| name | - |\n@| duration | - |\n@| startTime | - |\n@| path | - |\n@| referrerPath | - |\n@| pageId | - |\n@| referrerPageId | - |\n@| navigationStart | - |\n@| navigationType | - |\n@| initDataRecvTime | - |\n@| viewLayerRenderEndTime | - | \n\n###### getEntriesByType(entryType) @getentriesbytype\n获取当前列表中所有类型为 \\[entryType]的性能数据\n###### getEntriesByType HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| entryType | - | \n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n###### getEntriesByName(name, entryType) @getentriesbyname\n获取当前列表中所有名称为 \\[name] 且类型为 [entryType]的性能数据\n###### getEntriesByName HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| name | - |\n| entryType | - | \n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [PerformanceObserver](#performanceobserver-values) |\n\n###### PerformanceObserver 的方法 @performanceobserver-values \n\n###### observe(options) @observe\n开始监听\n###### observe HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| buffered | - |\n@| entryTypes | - |\n@| type | - | \n\n\n###### disconnect() @disconnect\n停止监听\n###### disconnect HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n \n\n#### getEntries() @getentries\n该方法返回当前缓冲区中的所有性能数据\n##### getEntries HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n#### getEntriesByType(entryType) @getentriesbytype\n获取当前缓冲区中所有类型为 \\[entryType]的性能数据\n##### getEntriesByType HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| entryType | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n#### getEntriesByName(name, entryType) @getentriesbyname\n获取当前缓冲区中所有名称为 \\[name] 且类型为 [entryType]的性能数据\n##### getEntriesByName HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| name | - |\n| entryType | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n#### setBufferSize(size) @setbuffersize\n设置缓冲区大小，默认缓冲 30 条性能数据\n##### setBufferSize HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| size | - | \n\n \n", "tutorial": "" }, "navigateTo": { "name": "## uni.navigateTo(options) @navigateto", "description": "保留当前页面，跳转到应用内的某个页面
", "compatibility": "### navigateTo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| url | 4.24 |\n@| events | 4.24 |\n@| success | 4.24 |\n@| fail | 4.24 |\n@| complete | 4.24 | \n\n##### NavigateToFail 的属性值 @navigatetofail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "reLaunch": { "name": "## uni.reLaunch(options) @relaunch", "description": "关闭所有页面，打开到应用内的某个页面
", "compatibility": "### reLaunch HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| url | 4.24 |\n@| success | 4.24 |\n@| fail | 4.24 |\n@| complete | 4.24 | \n\n##### ReLaunchFail 的属性值 @relaunchfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "navigateBack": { "name": "## uni.navigateBack(options?) @navigateback", "description": "关闭当前页面，返回上一页面或多级页面
", "compatibility": "### navigateBack HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| delta | 4.24 |\n@| success | - |\n@| fail | 4.24 |\n@| complete | 4.24 | \n\n##### NavigateBackFail 的属性值 @navigatebackfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "redirectTo": { "name": "## uni.redirectTo(options) @redirectto", "description": "关闭当前页面，跳转到应用内的某个页面
", "compatibility": "### redirectTo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| url | 4.24 |\n@| success | 4.24 |\n@| fail | 4.24 |\n@| complete | 4.24 | \n\n##### RedirectToFail 的属性值 @redirecttofail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "switchTab": { "name": "## uni.switchTab(options) @switchtab", "description": "跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
", "compatibility": "### switchTab HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| url | 4.24 |\n@| success | 4.24 |\n@| fail | 4.24 |\n@| complete | 4.24 | \n\n##### SwitchTabFail 的属性值 @switchtabfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "setNavigationBarColor": { "name": "## uni.setNavigationBarColor(options) setnavigationbarcolor", "description": "设置导航条、状态栏颜色
", "compatibility": "### setNavigationBarColor HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| frontColor | 4.24 |\n@| backgroundColor | 4.24 |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetNavigationBarColorFail 的属性值 @setnavigationbarcolorfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "setNavigationBarTitle": { "name": "## uni.setNavigationBarTitle(options) @setnavigationbartitle", "description": "动态设置当前页面的标题
", "compatibility": "### setNavigationBarTitle HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| title | 4.24 |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetNavigationBarTitleFail 的属性值 @setnavigationbartitlefail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "showTabBar": { "name": "## uni.showTabBar(options?) @showtabbar", "description": "显示 tabBar
", "compatibility": "### showTabBar HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| animation | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "hideTabBar": { "name": "## uni.hideTabBar(options?) @hidetabbar", "description": "隐藏 tabBar
", "compatibility": "### hideTabBar HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| animation | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "showTabBarRedDot": { "name": "## uni.showTabBarRedDot(options) @showtabbarreddot", "description": "显示 tabBar 某一项的右上角的红点
", "compatibility": "### showTabBarRedDot HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| index | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "hideTabBarRedDot": { "name": "## uni.hideTabBarRedDot(options) @hidetabbarreddot", "description": "隐藏 tabBar 某一项的右上角的红点
", "compatibility": "### hideTabBarRedDot HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| index | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "setTabBarBadge": { "name": "## uni.setTabBarBadge(options) @settabbarbadge", "description": "为 tabBar 某一项的右上角添加文本
", "compatibility": "### setTabBarBadge HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| index | - |\n@| text | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "removeTabBarBadge": { "name": "## uni.removeTabBarBadge(options) @removetabbarbadge", "description": "移除 tabBar 某一项右上角的文本
", "compatibility": "### removeTabBarBadge HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| index | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "setTabBarStyle": { "name": "## uni.setTabBarStyle(options) @settabbarstyle", "description": "动态设置 tabBar 的整体样式
", "compatibility": "### setTabBarStyle HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| color | - |\n@| selectedColor | - |\n@| backgroundColor | - |\n@| backgroundImage | - |\n@| backgroundRepeat | - |\n@| borderStyle | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "setTabBarItem": { "name": "## uni.setTabBarItem(options) @settabbaritem", "description": "动态设置 tabBar 某一项的内容
", "compatibility": "### setTabBarItem HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| index | - |\n@| text | - |\n@| iconPath | - |\n@| selectedIconPath | - |\n@| pagePath | - |\n@| iconfont | - |\n@| visible | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "startPullDownRefresh": { "name": "## uni.startPullDownRefresh(options?) @startpulldownrefresh", "description": "开始下拉刷新
", "compatibility": "### startPullDownRefresh HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### StartPullDownRefreshFail 的属性值 @startpulldownrefreshfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "stopPullDownRefresh": { "name": "## uni.stopPullDownRefresh() @stoppulldownrefresh", "description": "停止当前页面下拉刷新
", "compatibility": "### stopPullDownRefresh HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "", "returnValue": "", "tutorial": "" }, "pageScrollTo": { "name": "## uni.pageScrollTo(options) @pagescrollto", "description": "将页面滚动到目标位置
", "compatibility": "### pageScrollTo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| scrollTop | - |\n@| selector | - |\n@| offsetTop | 4.24 |\n@| duration | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### PageScrollToFail 的属性值 @pagescrolltofail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "onTabBarMidButtonTap": { "name": "## uni.onTabBarMidButtonTap(options) @ontabbarmidbuttontap", "description": "监听中间按钮的点击事件", "compatibility": "### onTabBarMidButtonTap HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - | \n", "returnValue": "", "tutorial": "" }, "getElementById": { "name": "## uni.getElementById(id) @getelementbyid", "description": "返回一个匹配特定 ID 的元素， 如果不存在，返回 null。\\
如果需要获取指定的节点类型，需要使用 as 进行类型转换。\\
ID 区分大小写，且应该是唯一的。如果存在多个匹配的元素，则返回第一个匹配的元素。
", "compatibility": "### getElementById HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| id | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n", "tutorial": "" }, "createSelectorQuery": { "name": "## uni.createSelectorQuery() @createselectorquery", "description": "返回一个SelectorQuery对象实例
", "compatibility": "### createSelectorQuery HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n\n#### SelectorQuery 的方法 @selectorquery-values \n\n#### in(component?) @in\n将选择器的选取范围更改为自定义组件component内\n##### in HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| component | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n#### select(selector) @select\n在当前页面下选择第一个匹配选择器selector的节点\n##### select HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| selector | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) |\n\n###### NodesRef 的方法 @nodesref-values \n\n###### boundingClientRect(callback?) @boundingclientrect\n添加节点的布局位置的查询请求，相对于显示区域，以像素为单位\n###### boundingClientRect HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### scrollOffset(callback) @scrolloffset\n添加节点的滚动位置查询请求，以像素为单位\n###### scrollOffset HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### fields(fields, callback) @fields\n获取节点的相关信息，需要获取的字段在fields中指定\n###### fields HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| fields | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| id | - |\n@| dataset | - |\n@| rect | - |\n@| size | - |\n@| scrollOffset | - |\n@| properties | - |\n@| computedStyle | - |\n@| context | - |\n@| node | - |\n| callback | - | \n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### context(callback) @context\n添加节点的 Context 对象查询请求\n###### context HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### node(callback) @node\n获取 Node 节点实例。目前支持 Canvas 的获取。\n###### node HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n \n\n#### selectAll(selector) @selectall\n在当前页面下选择匹配选择器selector的所有节点\n##### selectAll HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| selector | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) |\n \n\n#### selectViewport() @selectviewport\n选择显示区域\n##### selectViewport HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) |\n \n\n#### exec(callback) @exec\n执行所有的请求\n##### exec HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| [NodesRef](#nodesref-values) \\| null | 否 |\n \n \n", "tutorial": "" }, "createIntersectionObserver": { "name": "## uni.createIntersectionObserver(component, options) @createintersectionobserver", "description": "创建并返回一个 IntersectionObserver 对象实例
", "compatibility": "### createIntersectionObserver HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| component | - |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| thresholds | - |\n@| initialRatio | - |\n@| observeAll | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [IntersectionObserver](#intersectionobserver-values) |\n\n#### IntersectionObserver 的方法 @intersectionobserver-values \n\n#### relativeTo(selector, margins?) @relativeto\n使用选择器指定一个节点，作为参照区域之一\n##### relativeTo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| selector | - |\n| margins | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [IntersectionObserver](#intersectionobserver-values) |\n \n\n#### relativeToViewport(margins?) @relativetoviewport\n指定页面显示区域作为参照区域之一\n##### relativeToViewport HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| margins | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [IntersectionObserver](#intersectionobserver-values) |\n \n\n#### observe(targetSelector, callback) @observe\n指定目标节点并开始监听相交状态变化情况\n##### observe HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| targetSelector | - |\n| callback | - | \n\n###### ObserveResult 的属性值 @observeresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| intersectionRatio | - |\n| intersectionRect | - |\n| boundingClientRect | - |\n| relativeRect | - |\n| time | - |\n\n\n#### disconnect() @disconnect\n停止监听\n##### disconnect HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n \n", "tutorial": "" }, "showActionSheet": { "name": "## uni.showActionSheet(options) @showactionsheet", "description": "从底部向上弹出操作菜单", "compatibility": "### showActionSheet HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| title | - |\n@| alertText | - |\n@| itemList | - |\n@| itemColor | - |\n@| popover | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ShowActionSheetSuccess 的属性值 @showactionsheetsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| tapIndex | - |\n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "showModal": { "name": "## uni.showModal(options) @showmodal", "description": "显示模态弹窗，可以只有一个确定按钮，也可以同时有确定和取消按钮。类似于一个API整合了 html 中：alert、confirm。", "compatibility": "### showModal HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| title | - |\n@| content | - |\n@| showCancel | - |\n@| cancelText | - |\n@| cancelColor | - |\n@| confirmText | - |\n@| confirmColor | - |\n@| editable | - |\n@| placeholderText | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ShowModalSuccess 的属性值 @showmodalsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| confirm | - |\n| cancel | - |\n| content | - |\n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "showLoading": { "name": "## uni.showLoading(options) @showloading", "description": "显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。", "compatibility": "### showLoading HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| title | - |\n@| mask | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "hideLoading": { "name": "## uni.hideLoading() @hideloading", "description": "隐藏 loading 提示框。", "compatibility": "### hideLoading HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "", "returnValue": "", "tutorial": "" }, "showToast": { "name": "## uni.showToast(options) @showtoast", "description": "显示消息提示框", "compatibility": "### showToast HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| title | - |\n@| icon | - |\n@| image | - |\n@| mask | - |\n@| duration | - |\n@| position | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "hideToast": { "name": "## uni.hideToast() @hidetoast", "description": "隐藏消息提示框。", "compatibility": "### hideToast HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "", "returnValue": "", "tutorial": "" }, "loadFontFace": { "name": "## uni.loadFontFace(options) @loadfontface", "description": "动态加载网络字体
", "compatibility": "### loadFontFace HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| global | - |\n@| family | - |\n@| source | - |\n@| desc | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### LoadFontFaceFail 的属性值 @loadfontfacefail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n", "tutorial": "" }, "rpx2px": { "name": "## uni.rpx2px(number) @rpx2px", "description": "将rpx单位值转换成px", "compatibility": "### rpx2px HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| number | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| number |\n \n", "tutorial": "" }, "setAppTheme": { "name": "## uni.setAppTheme(options) @setapptheme", "description": "设置应用主题", "compatibility": "### setAppTheme HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | x | \n\n##### SetAppThemeSuccessResult 的属性值 @setappthemesuccessresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| theme | - |\n\n##### IAppThemeFail 的属性值 @iappthemefail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "onOsThemeChange": { "name": "## uni.onOsThemeChange(callback) @onosthemechange", "description": "开启监听系统主题变化", "compatibility": "### onOsThemeChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| number |\n \n", "tutorial": "" }, "offOsThemeChange": { "name": "## uni.offOsThemeChange(id) @offosthemechange", "description": "取消监听系统主题变化", "compatibility": "### offOsThemeChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| id | - | \n", "returnValue": "", "tutorial": "" }, "onAppThemeChange": { "name": "## uni.onAppThemeChange(callback) @onappthemechange", "description": "开启监听应用主题变化", "compatibility": "### onAppThemeChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| number |\n \n", "tutorial": "" }, "offAppThemeChange": { "name": "## uni.offAppThemeChange(id) @offappthemechange", "description": "取消监听应用主题变化", "compatibility": "### offAppThemeChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| id | - | \n", "returnValue": "", "tutorial": "" }, "onThemeChange": { "name": "## uni.onThemeChange(callback) @onthemechange", "description": "监听系统主题状态变化。
", "compatibility": "### onThemeChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnThemeChangeCallbackResult 的属性值 @onthemechangecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| theme | - |\n", "returnValue": "", "tutorial": "" }, "offThemeChange": { "name": "## uni.offThemeChange(callback) @offthemechange", "description": "取消监听系统主题状态变化。
", "compatibility": "### offThemeChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OffThemeChangeCallbackResult 的属性值 @offthemechangecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| theme | - |\n", "returnValue": "", "tutorial": "" }, "getLocale": { "name": "## uni.getLocale() @getlocale", "description": "获取当前设置的语言
", "compatibility": "### getLocale HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| string |\n \n", "tutorial": "" }, "setLocale": { "name": "## uni.setLocale(locale) @setlocale", "description": "设置当前语言
", "compatibility": "### setLocale HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| locale | - | \n", "returnValue": "", "tutorial": "" }, "onLocaleChange": { "name": "## uni.onLocaleChange(callback) @onlocalechange", "description": "设置当前语言
", "compatibility": "### onLocaleChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnLocaleChangeCallbackResult 的属性值 @onlocalechangecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| locale | - |\n", "returnValue": "", "tutorial": "" }, "request": { "name": "## uni.request(param) @request", "description": "发起网络请求。", "compatibility": "### request HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| param | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| url | 4.24 |\n@| data | 4.24 |\n@| header | 4.24 |\n@| method | 4.24 |\n@| timeout | - |\n@| withCredentials | x |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### RequestSuccess\\ 的属性值 @requestsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| data | 4.24 |\n| statusCode | 4.24 |\n| header | 4.24 |\n\n##### RequestFail 的属性值 @requestfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [RequestTask](#requesttask-values) |\n\n#### RequestTask 的方法 @requesttask-values \n\n#### abort() @abort\n中断网络请求。\n##### abort HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n\n \n", "tutorial": "" }, "uploadFile": { "name": "## uni.uploadFile(options) @uploadfile", "description": "将本地资源上传到开发者服务器。", "compatibility": "### uploadFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| url | 4.24 |\n@| filePath | 4.24 |\n@| name | 4.24 |\n@| files | 4.24 |\n@| header | 4.24 |\n@| formData | 4.24 |\n@| timeout | 4.24 |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### UploadFileSuccess 的属性值 @uploadfilesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| data | 4.24 |\n| statusCode | 4.24 |\n\n##### UploadFileFail 的属性值 @uploadfilefail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [UploadTask](#uploadtask-values) |\n\n#### UploadTask 的方法 @uploadtask-values \n\n#### abort() @abort\n中断上传任务。\n##### abort HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听上传进度变化。\n##### onProgressUpdate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### OnProgressUpdateResult 的属性值 @onprogressupdateresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| progress | 4.24 |\n| totalBytesSent | 4.24 |\n| totalBytesExpectedToSend | 4.24 |\n\n \n", "tutorial": "" }, "downloadFile": { "name": "## uni.downloadFile(options) @downloadfile", "description": "下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。", "compatibility": "### downloadFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| url | 4.24 |\n@| header | - |\n@| filePath | 4.24 |\n@| timeout | 4.24 |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### DownloadFileSuccess 的属性值 @downloadfilesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| tempFilePath | 4.24 |\n| statusCode | 4.24 |\n\n##### DownloadFileFail 的属性值 @downloadfilefail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [DownloadTask](#downloadtask-values) |\n\n#### DownloadTask 的方法 @downloadtask-values \n\n#### abort() @abort\n中断下载任务\n##### abort HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听下载进度变化。\n##### onProgressUpdate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### OnProgressDownloadResult 的属性值 @onprogressdownloadresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| progress | 4.24 |\n| totalBytesWritten | 4.24 |\n| totalBytesExpectedToWrite | 4.24 |\n\n \n", "tutorial": "" }, "getNetworkType": { "name": "## uni.getNetworkType(options) @getnetworktype", "description": "获取网络类型", "compatibility": "### getNetworkType HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetNetworkTypeSuccess 的属性值 @getnetworktypesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| networkType | - |\n", "returnValue": "", "tutorial": "" }, "connectSocket": { "name": "## uni.connectSocket(options) @connectsocket", "description": "创建一个 WebSocket 连接。", "compatibility": "### connectSocket HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| url | 4,24 |\n@| header | 4,24 |\n@| protocols | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ConnectSocketSuccess 的属性值 @connectsocketsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n\n##### ConnectSocketFail 的属性值 @connectsocketfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [SocketTask](#sockettask-values) |\n\n#### SocketTask 的方法 @sockettask-values \n\n#### send(options) @send\n通过 WebSocket 连接发送数据\n##### send HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| data | 4,24 |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### SendSocketMessageFail 的属性值 @sendsocketmessagefail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n\n#### close(options) @close\n关闭 WebSocket 连接\n##### close HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| code | 4,24 |\n@| reason | 4,24 |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### onOpen(callback) @onopen\n监听 WebSocket 连接打开事件\n##### onOpen HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### OnSocketOpenCallbackResult 的属性值 @onsocketopencallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| header | 4,24 |\n\n\n#### onClose(callback) @onclose\n监听 WebSocket 连接关闭事件\n##### onClose HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onError(callback) @onerror\n监听 WebSocket 错误\n##### onError HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4,24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onMessage(callback) @onmessage\n监听 WebSocket 接受到服务器的消息事件\n##### onMessage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4,24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| data | 4,24 |\n\n \n", "tutorial": "" }, "onSocketOpen": { "name": "## uni.onSocketOpen(options) @onsocketopen", "description": "监听WebSocket连接打开事件。", "compatibility": "### onSocketOpen HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - | \n", "returnValue": "", "tutorial": "" }, "onSocketError": { "name": "## uni.onSocketError(callback) @onsocketerror", "description": "监听WebSocket错误。", "compatibility": "### onSocketError HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnSocketErrorCallbackResult 的属性值 @onsocketerrorcallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "sendSocketMessage": { "name": "## uni.sendSocketMessage(options) @sendsocketmessage", "description": "通过 WebSocket 连接发送数据，需要先 uni.connectSocket，并在 uni.onSocketOpen 回调之后才能发送。", "compatibility": "### sendSocketMessage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| data | 4,24 |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SendSocketMessageFail 的属性值 @sendsocketmessagefail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "onSocketMessage": { "name": "## uni.onSocketMessage(callback) @onsocketmessage", "description": "监听WebSocket接受到服务器的消息事件。", "compatibility": "### onSocketMessage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| data | 4,24 |\n", "returnValue": "", "tutorial": "" }, "closeSocket": { "name": "## uni.closeSocket(options) @closesocket", "description": "关闭 WebSocket 连接。", "compatibility": "### closeSocket HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| code | 4,24 |\n@| reason | 4,24 |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "onSocketClose": { "name": "## uni.onSocketClose(callback) @onsocketclose", "description": "监听WebSocket关闭。", "compatibility": "### onSocketClose HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnSocketCloseCallbackResult 的属性值 @onsocketclosecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| code | 4.24 |\n| reason | 4.24 |\n", "returnValue": "", "tutorial": "" }, "getSystemInfo": { "name": "## uni.getSystemInfo(options) @getsysteminfo", "description": "异步获取系统信息", "compatibility": "### getSystemInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetSystemInfoResult 的属性值 @getsysteminforesult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| appId | 4.24 |\n| appLanguage | 4.24 |\n| appName | 4.24 |\n| appVersion | 4.24 |\n| appVersionCode | 4.24 |\n| browserName | x |\n| browserVersion | x |\n| deviceId | 4.24 |\n| deviceBrand | 4.24 |\n| deviceModel | 4.24 |\n| deviceType | 4.24 |\n| devicePixelRatio | 4.24 |\n| deviceOrientation | 4.24 |\n| ~~language~~ | x |\n| ~~model~~ | x |\n| osName | 4.24 |\n| osVersion | 4.24 |\n| osLanguage | 4.24 |\n| ~~pixelRatio~~ | x |\n| ~~platform~~ | x |\n| screenWidth | 4.24 |\n| screenHeight | 4.24 |\n| statusBarHeight | 4.24 |\n| ~~system~~ | 4.24 |\n| safeArea | 4.24 |\n| safeAreaInsets | 4.24 |\n| ua | x |\n| ~~uniCompileVersion~~ | x |\n| uniPlatform | 4.24 |\n| uniRuntimeVersion | 4.24 |\n| ~~uniCompileVersionCode~~ | x |\n| uniRuntimeVersionCode | 4.24 |\n| ~~version~~ | x |\n| windowWidth | 4.24 |\n| windowHeight | 4.24 |\n| windowTop | 4.24 |\n| windowBottom | 4.24 |\n", "returnValue": "", "tutorial": "" }, "getSystemInfoSync": { "name": "## uni.getSystemInfoSync() @getsysteminfosync", "description": "同步获取系统信息", "compatibility": "### getSystemInfoSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **GetSystemInfoResult** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| appId | 4.24 |\n@| appLanguage | 4.24 |\n@| appName | 4.24 |\n@| appVersion | 4.24 |\n@| appVersionCode | 4.24 |\n@| browserName | x |\n@| browserVersion | x |\n@| deviceId | 4.24 |\n@| deviceBrand | 4.24 |\n@| deviceModel | 4.24 |\n@| deviceType | 4.24 |\n@| devicePixelRatio | 4.24 |\n@| deviceOrientation | 4.24 |\n@| ~~language~~ | x |\n@| ~~model~~ | x |\n@| osName | 4.24 |\n@| osVersion | 4.24 |\n@| osLanguage | 4.24 |\n@| ~~pixelRatio~~ | x |\n@| ~~platform~~ | x |\n@| screenWidth | 4.24 |\n@| screenHeight | 4.24 |\n@| statusBarHeight | 4.24 |\n@| ~~system~~ | 4.24 |\n@| safeArea | 4.24 |\n@| safeAreaInsets | 4.24 |\n@| ua | x |\n@| ~~uniCompileVersion~~ | x |\n@| uniPlatform | 4.24 |\n@| uniRuntimeVersion | 4.24 |\n@| ~~uniCompileVersionCode~~ | x |\n@| uniRuntimeVersionCode | 4.24 |\n@| ~~version~~ | x |\n@| windowWidth | 4.24 |\n@| windowHeight | 4.24 |\n@| windowTop | 4.24 |\n@| windowBottom | 4.24 | \n", "tutorial": "" }, "getDeviceInfo": { "name": "## uni.getDeviceInfo(options?) @getdeviceinfo", "description": "获取设备信息", "compatibility": "### getDeviceInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filter | x | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **GetDeviceInfoResult** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| deviceId | 4.24 |\n@| ~~model~~ | x |\n@| deviceModel | 4.24 |\n@| deviceType | 4.24 |\n@| deviceOrientation | 4.24 |\n@| devicePixelRatio | 4.24 |\n@| system | 4.24 |\n@| platform | 4.24 | \n", "tutorial": "" }, "getWindowInfo": { "name": "## uni.getWindowInfo() @getwindowinfo", "description": "同步获取窗口信息", "compatibility": "### getWindowInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **GetWindowInfoResult** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| pixelRatio | 4.24 |\n@| screenWidth | 4.24 |\n@| screenHeight | 4.24 |\n@| windowWidth | 4.24 |\n@| windowHeight | 4.24 |\n@| statusBarHeight | 4.24 |\n@| windowTop | 4.24 |\n@| windowBottom | 4.24 |\n@| safeArea | 4.24 |\n@| safeAreaInsets | 4.24 |\n@| screenTop | 4.24 | \n", "tutorial": "" }, "getAppBaseInfo": { "name": "## uni.getAppBaseInfo(options?) @getappbaseinfo", "description": "获取app基本信息", "compatibility": "### getAppBaseInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filter | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **GetAppBaseInfoResult** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| appId | 4.24 |\n@| appName | 4.24 |\n@| appVersion | 4.24 |\n@| appVersionCode | 4.24 |\n@| appLanguage | 4.24 |\n@| language | x |\n@| uniPlatform | 4.24 | \n", "tutorial": "" }, "getAppAuthorizeSetting": { "name": "## uni.getAppAuthorizeSetting() @getappauthorizesetting", "description": "获取 APP 授权设置。", "compatibility": "### getAppAuthorizeSetting HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **GetAppAuthorizeSettingResult** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| albumAuthorized | - |\n@| bluetoothAuthorized | - |\n@| cameraAuthorized | - |\n@| locationAuthorized | - |\n@| locationAccuracy | - |\n@| locationReducedAccuracy | - |\n@| microphoneAuthorized | - |\n@| notificationAuthorized | - |\n@| notificationAlertAuthorized | - |\n@| notificationBadgeAuthorized | - |\n@| notificationSoundAuthorized | - |\n@| phoneCalendarAuthorized | x | \n", "tutorial": "" }, "getSystemSetting": { "name": "## uni.getSystemSetting() @getsystemsetting", "description": "获取系统设置", "compatibility": "### getSystemSetting HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **GetSystemSettingResult** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| bluetoothEnabled | - |\n@| bluetoothError | - |\n@| locationEnabled | - |\n@| wifiEnabled | - |\n@| wifiError | - |\n@| deviceOrientation | - | \n", "tutorial": "" }, "installApk": { "name": "## uni.installApk(options) @installapk", "description": "安装apk", "compatibility": "### installApk HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### InstallApkSuccess 的属性值 @installapksuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n\n##### InstallApkFail 的属性值 @installapkfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "getPushClientId": { "name": "## uni.getPushClientId(options) @getpushclientid", "description": "获取客户端唯一的推送标识", "compatibility": "### getPushClientId HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetPushClientIdSuccess 的属性值 @getpushclientidsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| cid | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "onPushMessage": { "name": "## uni.onPushMessage(callback) @onpushmessage", "description": "启动监听推送消息事件", "compatibility": "### onPushMessage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| type | - |\n| data | - |\n", "returnValue": "", "tutorial": "" }, "offPushMessage": { "name": "## uni.offPushMessage(callback) @offpushmessage", "description": "关闭推送消息监听事件，iOS端调用会关闭所有监听。", "compatibility": "### offPushMessage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| type | - |\n| data | - |\n", "returnValue": "", "tutorial": "" }, "getChannelManager": { "name": "## uni.~~getChannelManager~~() @getchannelmanager", "description": "获取通知渠道管理器，Android 8系统以上才可以设置通知渠道，Android 8系统以下返回null。 **已废弃，仅为了向下兼容保留，建议使用`getPushChannelManager`。**", "compatibility": "### getChannelManager HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [ChannelManager](#channelmanager-values) |\n\n#### ChannelManager 的方法 @channelmanager-values \n\n#### setPushChannel(options) @setpushchannel\n设置推送渠道
\n##### setPushChannel HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| soundName | - |\n@| channelId | - |\n@| channelDesc | - |\n@| enableLights | - |\n@| enableVibration | - |\n@| importance | - |\n@| lockscreenVisibility | - | \n\n\n#### getAllChannels() @getallchannels\n获取当前应用注册的所有的通知渠道。
\n##### getAllChannels HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Array\\ |\n \n \n", "tutorial": "" }, "createPushMessage": { "name": "## uni.createPushMessage(options) @createpushmessage", "description": "创建本地通知栏消息", "compatibility": "### createPushMessage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| cover | - |\n@| delay | - |\n@| icon | - |\n@| sound | - |\n@| title | - |\n@| content | - |\n@| payload | - |\n@| when | - |\n@| channelId | - |\n@| category | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "getBatteryInfo": { "name": "## uni.getBatteryInfo(options) @getbatteryinfo", "description": "获取电池电量信息

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)
", "compatibility": "### getBatteryInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetBatteryInfoSuccess 的属性值 @getbatteryinfosuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n| level | - |\n| isCharging | - |\n", "returnValue": "", "tutorial": "" }, "getBatteryInfoSync": { "name": "## uni.getBatteryInfoSync() @getbatteryinfosync", "description": "获取电池电量信息

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)
", "compatibility": "### getBatteryInfoSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **GetBatteryInfoResult** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| level | - |\n@| isCharging | - | \n", "tutorial": "" }, "makePhoneCall": { "name": "## uni.makePhoneCall(options) @makephonecall", "description": "拨打电话
", "compatibility": "### makePhoneCall HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| phoneNumber | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "getClipboardData": { "name": "## uni.getClipboardData(options) @getclipboarddata", "description": "获得系统剪贴板的内容
", "compatibility": "### getClipboardData HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetClipboardDataSuccess 的属性值 @getclipboarddatasuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| data | - |\n", "returnValue": "", "tutorial": "" }, "setClipboardData": { "name": "## uni.setClipboardData(options) @setclipboarddata", "description": "设置系统剪贴板的内容
", "compatibility": "### setClipboardData HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| data | - |\n@| showToast | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "onCompassChange": { "name": "## uni.onCompassChange(callback) @oncompasschange", "description": "监听罗盘数据
", "compatibility": "### onCompassChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnCompassChangeSuccess 的属性值 @oncompasschangesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| direction | - |\n", "returnValue": "", "tutorial": "" }, "offCompassChange": { "name": "## uni.offCompassChange(callback) @offcompasschange", "description": "取消监听罗盘数据
", "compatibility": "### offCompassChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n", "returnValue": "", "tutorial": "" }, "startCompass": { "name": "## uni.startCompass(options?) @startcompass", "description": "开始监听罗盘数据
", "compatibility": "### startCompass HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ICompassError 的属性值 @icompasserror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "stopCompass": { "name": "## uni.stopCompass(options?) @stopcompass", "description": "停止监听罗盘数据
", "compatibility": "### stopCompass HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ICompassError 的属性值 @icompasserror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "onAccelerometerChange": { "name": "## uni.onAccelerometerChange(callback) @onaccelerometerchange", "description": "监听加速度数据
", "compatibility": "### onAccelerometerChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnAccelerometerChangeCallbackResult 的属性值 @onaccelerometerchangecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - |\n| z | - |\n", "returnValue": "", "tutorial": "" }, "offAccelerometerChange": { "name": "## uni.offAccelerometerChange(callback) @offaccelerometerchange", "description": "取消监听加速度数据
", "compatibility": "### offAccelerometerChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n", "returnValue": "", "tutorial": "" }, "startAccelerometer": { "name": "## uni.startAccelerometer(options) @startaccelerometer", "description": "开始监听加速度数据
", "compatibility": "### startAccelerometer HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| interval | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "stopAccelerometer": { "name": "## uni.stopAccelerometer(options) @stopaccelerometer", "description": "停止监听加速度数据
", "compatibility": "### stopAccelerometer HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "startWifi": { "name": "## uni.startWifi(option) @startwifi", "description": "初始化Wi-Fi模块


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### startWifi HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| option | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| errMsg | - |\n| wifi | - |\n", "returnValue": "", "tutorial": "" }, "stopWifi": { "name": "## uni.stopWifi(option) @stopwifi", "description": "关闭 Wi-Fi 模块


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### stopWifi HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| option | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| errMsg | - |\n| wifi | - |\n", "returnValue": "", "tutorial": "" }, "connectWifi": { "name": "## uni.connectWifi(option) @connectwifi", "description": "", "compatibility": "### connectWifi HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| option | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| SSID | - |\n@| BSSID | - |\n@| password | - |\n@| maunal | - |\n@| partialInfo | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| errMsg | - |\n| wifi | - |\n", "returnValue": "", "tutorial": "" }, "getWifiList": { "name": "## uni.getWifiList(option) @getwifilist", "description": "请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### getWifiList HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| option | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| errMsg | - |\n| wifi | - |\n", "returnValue": "", "tutorial": "" }, "onGetWifiList": { "name": "## uni.onGetWifiList(callback) @ongetwifilist", "description": "监听获取到 Wi-Fi 列表数据事件。


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### onGetWifiList HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n", "returnValue": "", "tutorial": "" }, "offGetWifiList": { "name": "## uni.offGetWifiList(callback) @offgetwifilist", "description": "移除获取到 Wi-Fi 列表数据事件的监听函数。


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### offGetWifiList HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n", "returnValue": "", "tutorial": "" }, "getConnectedWifi": { "name": "## uni.getConnectedWifi(option) @getconnectedwifi", "description": "获取已连接的 Wi-Fi 信息


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### getConnectedWifi HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| option | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| partialInfo | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| errMsg | - |\n| wifi | - |\n", "returnValue": "", "tutorial": "" }, "onWifiConnected": { "name": "## uni.onWifiConnected(callback) @onwificonnected", "description": "监听连接上 Wi-Fi 的事件


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### onWifiConnected HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| errMsg | - |\n| wifi | - |\n", "returnValue": "", "tutorial": "" }, "onWifiConnectedWithPartialInfo": { "name": "## uni.onWifiConnectedWithPartialInfo(callback) @onwificonnectedwithpartialinfo", "description": "监听连接上 Wi-Fi 的事件。


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### onWifiConnectedWithPartialInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### UniWifiInfoWithPartialInfo 的属性值 @uniwifiinfowithpartialinfo-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| SSID | - |\n", "returnValue": "", "tutorial": "" }, "offWifiConnected": { "name": "## uni.offWifiConnected(callback?) @offwificonnected", "description": "移除连接上 Wi-Fi 的事件的监听函数。


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### offWifiConnected HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n", "returnValue": "", "tutorial": "" }, "setWifiList": { "name": "## uni.setWifiList(option) @setwifilist", "description": "SetWifiList 暂未实现


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
", "compatibility": "### setWifiList HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| option | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| errMsg | - |\n| wifi | - |\n", "returnValue": "", "tutorial": "" }, "onMemoryWarning": { "name": "## uni.onMemoryWarning(callback) @onmemorywarning", "description": "监听内存不足告警事件。
", "compatibility": "### onMemoryWarning HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnMemoryWarningCallbackResult 的属性值 @onmemorywarningcallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| level | - |\n", "returnValue": "", "tutorial": "" }, "offMemoryWarning": { "name": "## uni.offMemoryWarning(callback) @offmemorywarning", "description": "取消监听内存不足告警事件。不传入 callback 则取消所有监听。
", "compatibility": "### offMemoryWarning HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OffMemoryWarningCallbackResult 的属性值 @offmemorywarningcallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| level | - |\n", "returnValue": "", "tutorial": "" }, "onUserCaptureScreen": { "name": "## uni.onUserCaptureScreen(callback?) @onusercapturescreen", "description": "开启截屏监听


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)
", "compatibility": "### onUserCaptureScreen HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnUserCaptureScreenCallbackResult 的属性值 @onusercapturescreencallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| path | - |\n", "returnValue": "", "tutorial": "" }, "offUserCaptureScreen": { "name": "## uni.offUserCaptureScreen(callback?) @offusercapturescreen", "description": "关闭截屏监听


> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)
", "compatibility": "### offUserCaptureScreen HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnUserCaptureScreenCallbackResult 的属性值 @onusercapturescreencallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| path | - |\n", "returnValue": "", "tutorial": "" }, "createRequestPermissionListener": { "name": "## uni.createRequestPermissionListener() @createrequestpermissionlistener", "description": "创建一个监听权限申请的对象。", "compatibility": "### createRequestPermissionListener HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [RequestPermissionListener](#requestpermissionlistener-values) |\n\n#### RequestPermissionListener 的方法 @requestpermissionlistener-values \n\n#### onRequest(callback) @onrequest\n监听申请系统权限\n##### onRequest HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onConfirm(callback) @onconfirm\n监听弹出系统权限授权框\n##### onConfirm HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onComplete(callback) @oncomplete\n监听权限申请完成\n##### onComplete HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### stop() @stop\n取消所有监听\n##### stop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n \n", "tutorial": "" }, "chooseImage": { "name": "## uni.chooseImage(options) @chooseimage", "description": "从本地相册选择图片或使用相机拍照", "compatibility": "### chooseImage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| count | - |\n@| sourceType | - |\n@| extension | 4.24 |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ChooseImageSuccess 的属性值 @chooseimagesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errSubject | - |\n| errMsg | - |\n| tempFilePaths | - |\n| tempFiles | - |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "previewImage": { "name": "## uni.previewImage(options) @previewimage", "description": "预览图片", "compatibility": "### previewImage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| current | - |\n@| urls | - |\n@| showmenu | - |\n@| indicator | x |\n@| loop | - |\n@| longPressActions | x |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### LongPressActionsSuccessData 的属性值 @longpressactionssuccessdata-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| tapIndex | - |\n| index | - |\n\n##### PreviewImageSuccess 的属性值 @previewimagesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errSubject | - |\n| errMsg | - |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "closePreviewImage": { "name": "## uni.closePreviewImage(options) @closepreviewimage", "description": "关闭图片预览", "compatibility": "### closePreviewImage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ClosePreviewImageSuccess 的属性值 @closepreviewimagesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "saveImageToPhotosAlbum": { "name": "## uni.saveImageToPhotosAlbum(options) @saveimagetophotosalbum", "description": "保存图片到系统相册", "compatibility": "### saveImageToPhotosAlbum HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### SaveImageToPhotosAlbumSuccess 的属性值 @saveimagetophotosalbumsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| path | - |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "getImageInfo": { "name": "## uni.getImageInfo(options) @getimageinfo", "description": "获取图片信息", "compatibility": "### getImageInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| src | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetImageInfoSuccess 的属性值 @getimageinfosuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| width | - |\n| height | - |\n| path | - |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "compressImage": { "name": "## uni.compressImage(options) @compressimage", "description": "压缩图片", "compatibility": "### compressImage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| src | - |\n@| quality | - |\n@| rotate | - |\n@| ~~width~~ | - |\n@| ~~height~~ | - |\n@| compressedHeight | - |\n@| compressedWidth | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### CompressImageSuccess 的属性值 @compressimagesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| tempFilePath | - |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "chooseVideo": { "name": "## uni.chooseVideo(options) @choosevideo", "description": "拍摄视频或从手机相册中选视频，返回视频的临时文件路径。", "compatibility": "### chooseVideo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| sourceType | - |\n@| extension | x |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ChooseVideoSuccess 的属性值 @choosevideosuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| tempFilePath | - |\n| duration | - |\n| size | - |\n| height | - |\n| width | - |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "saveVideoToPhotosAlbum": { "name": "## uni.saveVideoToPhotosAlbum(options) @savevideotophotosalbum", "description": "保存视频到系统相册", "compatibility": "### saveVideoToPhotosAlbum HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "getVideoInfo": { "name": "## uni.getVideoInfo(options) @getvideoinfo", "description": "获取视频详细信息", "compatibility": "### getVideoInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| src | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetVideoInfoSuccess 的属性值 @getvideoinfosuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| duration | - |\n| size | - |\n| height | - |\n| width | - |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "compressVideo": { "name": "## uni.compressVideo(options) @compressvideo", "description": "压缩视频", "compatibility": "### compressVideo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| src | - |\n@| quality | - |\n@| bitrate | - |\n@| fps | - |\n@| resolution | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### CompressVideoSuccess 的属性值 @compressvideosuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| tempFilePath | - |\n| size | - |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "createInnerAudioContext": { "name": "## uni.createInnerAudioContext() @createinneraudiocontext", "description": "创建并返回 audio 上下文 audioContext 对象
", "compatibility": "### createInnerAudioContext HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [InnerAudioContext](#inneraudiocontext-values) |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| duration | - |\n@| currentTime | - |\n@| paused | - |\n@| src | - |\n@| startTime | - |\n@| buffered | - |\n@| autoplay | - |\n@| loop | - |\n@| obeyMuteSwitch | - |\n@| volume | - |\n@| playbackRate | - |\n#### InnerAudioContext 的方法 @inneraudiocontext-values \n\n#### pause() @pause\n暂停\n##### pause HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### stop() @stop\n停止\n##### stop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### play() @play\n播放\n##### play HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### seek(position) @seek\n跳转到指定位置，单位 s\n##### seek HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| position | - | \n\n\n#### destroy() @destroy\n销毁当前实例\n##### destroy HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### onCanplay(callback) @oncanplay\n音频进入可以播放状态，但不保证后面可以流畅播放\n##### onCanplay HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onPlay(callback) @onplay\n音频播放事件\n##### onPlay HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onPause(callback) @onpause\n音频暂停事件\n##### onPause HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onStop(callback) @onstop\n音频停止事件\n##### onStop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onEnded(callback) @onended\n音频自然播放结束事件\n##### onEnded HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onTimeUpdate(callback) @ontimeupdate\n音频播放进度更新事件\n##### onTimeUpdate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onError(callback) @onerror\n音频播放错误事件\n##### onError HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onWaiting(callback) @onwaiting\n音频加载中事件，当音频因为数据不足，需要停下来加载时会触发\n##### onWaiting HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onSeeking(callback) @onseeking\n音频进行 seek 操作事件\n##### onSeeking HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onSeeked(callback) @onseeked\n音频完成 seek 操作事件\n##### onSeeked HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offCanplay(callback) @offcanplay\n取消监听 onCanplay 事件\n##### offCanplay HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offPlay(callback) @offplay\n取消监听 onPlay 事件\n##### offPlay HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offPause(callback) @offpause\n取消监听 onPause 事件\n##### offPause HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offStop(callback) @offstop\n取消监听 onStop 事件\n##### offStop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offEnded(callback) @offended\n取消监听 onEnded 事件\n##### offEnded HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offTimeUpdate(callback) @offtimeupdate\n取消监听 onTimeUpdate 事件\n##### offTimeUpdate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offError(callback) @offerror\n取消监听 onWaiting 事件\n##### offError HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offWaiting(callback) @offwaiting\n取消监听 onWaiting 事件\n##### offWaiting HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offSeeking(callback) @offseeking\n取消监听 onSeeking 事件\n##### offSeeking HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offSeeked(callback) @offseeked\n取消监听 onSeeked 事件\n##### offSeeked HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n \n", "tutorial": "" }, "getBackgroundAudioManager": { "name": "## uni.getBackgroundAudioManager() @getbackgroundaudiomanager", "description": "获取全局唯一的背景音频管理器 backgroundAudioManager
", "compatibility": "### getBackgroundAudioManager HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [BackgroundAudioManager](#backgroundaudiomanager-values) |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| duration | - |\n@| currentTime | - |\n@| paused | - |\n@| src | - |\n@| startTime | - |\n@| buffered | - |\n@| title | - |\n@| epname | - |\n@| singer | - |\n@| coverImgUrl | - |\n@| webUrl | - |\n@| protocol | - |\n@| playbackRate | - |\n#### BackgroundAudioManager 的方法 @backgroundaudiomanager-values \n\n#### play() @play\n播放\n##### play HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### pause() @pause\n暂停\n##### pause HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### seek(position) @seek\n跳转到指定位置，单位 s\n##### seek HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| position | - | \n\n\n#### stop() @stop\n停止\n##### stop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### onCanplay(callback) @oncanplay\n背景音频进入可以播放状态，但不保证后面可以流畅播放\n##### onCanplay HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onPlay(callback) @onplay\n背景音频播放事件\n##### onPlay HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onPause(callback) @onpause\n背景音频暂停事件\n##### onPause HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onStop(callback) @onstop\n背景音频停止事件\n##### onStop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onEnded(callback) @onended\n背景音频自然播放结束事件\n##### onEnded HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onTimeUpdate(callback) @ontimeupdate\n背景音频播放进度更新事件\n##### onTimeUpdate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onPrev(callback) @onprev\n用户在系统音乐播放面板点击上一曲事件（iOS only）\n##### onPrev HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onNext(callback) @onnext\n用户在系统音乐播放面板点击下一曲事件（iOS only）\n##### onNext HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onError(callback) @onerror\n背景音频播放错误事件\n##### onError HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onWaiting(callback) @onwaiting\n音频加载中事件，当音频因为数据不足，需要停下来加载时会触发\n##### onWaiting HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n \n", "tutorial": "" }, "getLocation": { "name": "## uni.getLocation(options) @getlocation", "description": "获取当前的地理位置、速度", "compatibility": "### getLocation HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| provider | - |\n@| type | - |\n@| altitude | - |\n@| geocode | - |\n@| highAccuracyExpireTime | - |\n@| isHighAccuracy | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetLocationSuccess 的属性值 @getlocationsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| latitude | - |\n| longitude | - |\n| speed | - |\n| accuracy | - |\n| altitude | - |\n| verticalAccuracy | - |\n| horizontalAccuracy | - |\n| address | - |\n\n##### IUniError 的属性值 @iunierror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "openLocation": { "name": "## uni.openLocation(options) @openlocation", "description": "使用地图查看位置
", "compatibility": "### openLocation HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| latitude | - |\n@| longitude | - |\n@| scale | - |\n@| name | - |\n@| address | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### IOpenLocationError 的属性值 @iopenlocationerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "chooseLocation": { "name": "## uni.chooseLocation(options) @chooselocation", "description": "打开地图选择位置。", "compatibility": "### chooseLocation HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| latitude | - |\n@| longitude | - |\n@| keyword | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### ChooseLocationSuccess 的属性值 @chooselocationsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| name | - |\n| address | - |\n| latitude | - |\n| longitude | - |\n\n##### IChooseLocationError 的属性值 @ichooselocationerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "onLocationChange": { "name": "## uni.onLocationChange(callback) @onlocationchange", "description": "监听实时地理位置变化事件，需结合 uni.startLocationUpdate 或 uni.startLocationUpdateBackground 使用。
", "compatibility": "### onLocationChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OnLocationChangeCallbackResult 的属性值 @onlocationchangecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| latitude | - |\n| longitude | - |\n| accuracy | - |\n| altitude | - |\n| altitudeAccuracy | - |\n| speed | - |\n| horizontalAccuracy | - |\n| verticalAccuracy | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| any |\n \n", "tutorial": "" }, "offLocationChange": { "name": "## uni.offLocationChange(callback) @offlocationchange", "description": "关闭监听实时位置变化，前后台都停止消息接收。
", "compatibility": "### offLocationChange HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n#### OffLocationChangeCallbackResult 的属性值 @offlocationchangecallbackresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| latitude | - |\n| longitude | - |\n| accuracy | - |\n| altitude | - |\n| altitudeAccuracy | - |\n| speed | - |\n| horizontalAccuracy | - |\n| verticalAccuracy | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| any |\n \n", "tutorial": "" }, "onLocationChangeError": { "name": "## uni.onLocationChangeError(callback) @onlocationchangeerror", "description": "监听持续定位接口返回失败时触发。
", "compatibility": "### onLocationChangeError HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| any |\n \n", "tutorial": "" }, "offLocationChangeError": { "name": "## uni.offLocationChangeError(callback) @offlocationchangeerror", "description": "取消注册位置更新错误回调。
", "compatibility": "### offLocationChangeError HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| any |\n \n", "tutorial": "" }, "startLocationUpdate": { "name": "## uni.startLocationUpdate(options) @startlocationupdate", "description": "开启小程序进入前台时接收位置消息。
", "compatibility": "### startLocationUpdate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| type | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### StartLocationUpdateSuccess 的属性值 @startlocationupdatesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| name | - |\n| address | - |\n| latitude | - |\n| longitude | - |\n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| any |\n \n", "tutorial": "" }, "stopLocationUpdate": { "name": "## uni.stopLocationUpdate(options) @stoplocationupdate", "description": "关闭监听实时位置变化，前后台都停止消息接收。
", "compatibility": "### stopLocationUpdate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| any |\n \n", "tutorial": "" }, "getStorageInfo": { "name": "## uni.getStorageInfo(options) @getstorageinfo", "description": "uni.getStorageInfo函数定义
异步获取当前 storage 的相关信息。
", "compatibility": "### getStorageInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetStorageInfoSuccess 的属性值 @getstorageinfosuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| keys | - |\n| currentSize | - |\n| limitSize | - |\n", "returnValue": "", "tutorial": "" }, "getStorageInfoSync": { "name": "## uni.getStorageInfoSync() @getstorageinfosync", "description": "uni.getStorageInfoSync函数定义
同步获取当前 storage 的相关信息。
", "compatibility": "### getStorageInfoSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **GetStorageInfoSuccess** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| keys | - |\n@| currentSize | - |\n@| limitSize | - | \n", "tutorial": "" }, "getStorage": { "name": "## uni.getStorage(options) @getstorage", "description": "uni.getStorage函数定义
从本地存储中异步获取指定 key 对应的内容。
", "compatibility": "### getStorage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| key | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### GetStorageSuccess 的属性值 @getstoragesuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| data | - |\n", "returnValue": "", "tutorial": "" }, "getStorageSync": { "name": "## uni.getStorageSync(key) @getstoragesync", "description": "uni.getStorageSync函数定义
从本地存储中同步获取指定 key 对应的内容。
", "compatibility": "### getStorageSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| key | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n", "tutorial": "" }, "setStorage": { "name": "## uni.setStorage(options) @setstorage", "description": "uni.setStorage函数定义
将数据存储在本地storage存储中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。
", "compatibility": "### setStorage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| key | - |\n@| data | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "setStorageSync": { "name": "## uni.setStorageSync(key, data) @setstoragesync", "description": "uni.setStorageSync函数定义
将 data 存储在本地storage存储中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。
", "compatibility": "### setStorageSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| key | - |\n| data | - | \n", "returnValue": "", "tutorial": "" }, "removeStorage": { "name": "## uni.removeStorage(options) @removestorage", "description": "uni.removeStorage函数定义
从本地存储中异步移除指定 key。
", "compatibility": "### removeStorage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| key | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "removeStorageSync": { "name": "## uni.removeStorageSync(key) @removestoragesync", "description": "uni.removeStorageSync函数定义
从本地存储中同步移除指定 key。
", "compatibility": "### removeStorageSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| key | - | \n", "returnValue": "", "tutorial": "" }, "clearStorage": { "name": "## uni.clearStorage(option?) @clearstorage", "description": "uni.clearStorage函数定义
清除本地数据存储。
", "compatibility": "### clearStorage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| option | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "clearStorageSync": { "name": "## uni.clearStorageSync() @clearstoragesync", "description": "uni.clearStorageSync函数定义
清除本地数据存储。
", "compatibility": "### clearStorageSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "", "returnValue": "", "tutorial": "" }, "getFileSystemManager": { "name": "## uni.getFileSystemManager() @getfilesystemmanager", "description": "获取文件管理器", "compatibility": "### getFileSystemManager HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [FileSystemManager](#filesystemmanager-values) |\n\n#### FileSystemManager 的方法 @filesystemmanager-values \n\n#### readFile(options) @readfile\n读取本地文件内容\n##### readFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| encoding | - |\n@| filePath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### ReadFileSuccessResult 的属性值 @readfilesuccessresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| data | - |\n\n###### IFileSystemManagerFail 的属性值 @ifilesystemmanagerfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n\n#### readFileSync(filePath, encoding?) @readfilesync\nFileSystemManager.readFile 的同步版本参数\n##### readFileSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| filePath | - |\n| encoding | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| string |\n \n\n#### writeFile(options) @writefile\n写文件\n##### writeFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| encoding | - |\n@| data | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### FileManagerSuccessResult 的属性值 @filemanagersuccessresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n\n\n#### writeFileSync(filePath, data, encoding) @writefilesync\nFileSystemManager.writeFile 的同步版本\n##### writeFileSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| filePath | - |\n| data | - |\n| encoding | - | \n\n\n#### unlink(options) @unlink\n删除文件\n##### unlink HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### unlinkSync(filePath) @unlinksync\nFileSystemManager.unlink 的同步版本\n##### unlinkSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| filePath | - | \n\n\n#### mkdir(options) @mkdir\n创建目录\n##### mkdir HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| dirPath | - |\n@| recursive | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### mkdirSync(dirPath, recursive) @mkdirsync\nFileSystemManager.mkdir 的同步版本\n##### mkdirSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| dirPath | - |\n| recursive | - | \n\n\n#### rmdir(options) @rmdir\n删除目录\n##### rmdir HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| dirPath | - |\n@| recursive | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### rmdirSync(dirPath, recursive) @rmdirsync\nFileSystemManager.rmdir 的同步版本\n##### rmdirSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| dirPath | - |\n| recursive | - | \n\n\n#### readdir(options) @readdir\n读取目录内文件列表\n##### readdir HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| dirPath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### ReadDirSuccessResult 的属性值 @readdirsuccessresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| files | - |\n\n\n#### readdirSync(dirPath) @readdirsync\nFileSystemManager.readdir 的同步版本\n##### readdirSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| dirPath | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| Array\\ \\| null | 否 |\n \n\n#### access(options) @access\n判断文件/目录是否存在\n##### access HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| path | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### accessSync(path) @accesssync\nFileSystemManager.access 的同步版本\n##### accessSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| path | - | \n\n\n#### rename(options) @rename\n重命名文件。可以把文件从 oldPath 移动到 newPath\n##### rename HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| oldPath | - |\n@| newPath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### renameSync(oldPath, newPath) @renamesync\nFileSystemManager.rename 的同步版本\n##### renameSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| oldPath | - |\n| newPath | - | \n\n\n#### copyFile(options) @copyfile\n复制文件\n##### copyFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| srcPath | - |\n@| destPath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### copyFileSync(srcPath, destPath) @copyfilesync\nFileSystemManager.copyFile 的同步版本\n##### copyFileSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| srcPath | - |\n| destPath | - | \n\n\n#### getFileInfo(options) @getfileinfo\n获取该本地临时文件 或 本地缓存文件 信息\n##### getFileInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| digestAlgorithm | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### GetFileInfoSuccessResult 的属性值 @getfileinfosuccessresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| digest | - |\n| size | - |\n| errMsg | - |\n\n\n#### stat(options) @stat\n获取文件 Stats 对象\n##### stat HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| path | - |\n@| recursive | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### StatSuccessResult 的属性值 @statsuccessresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n| stats | - |\n\n###### Stats 的方法 @stats-values \n\n###### isDirectory() @isdirectory\n判断当前文件是否一个目录\n###### isDirectory HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### isFile() @isfile\n判断当前文件是否一个普通文件\n###### isFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n###### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n\n#### statSync(path, recursive) @statsync\nFileSystemManager.stat 的同步版本\n##### statSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| path | - |\n| recursive | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Array\\<[FileStats](#filestats-values)\\> |\n \n\n#### appendFile(options) @appendfile\n在文件结尾追加内容\n##### appendFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| encoding | - |\n@| data | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### appendFileSync(filePath, data, encoding) @appendfilesync\nFileSystemManager.appendFile 的同步版本\n##### appendFileSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| filePath | - |\n| data | - |\n| encoding | - | \n\n\n#### saveFile(options) @savefile\n保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用。\n##### saveFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| tempFilePath | - |\n@| filePath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### SaveFileSuccessResult 的属性值 @savefilesuccessresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| savedFilePath | - |\n\n\n#### saveFileSync(tempFilePath, filePath?) @savefilesync\nFileSystemManager.saveFile 的同步版本\n##### saveFileSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| tempFilePath | - |\n| filePath | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| string |\n \n\n#### removeSavedFile(options) @removesavedfile\n删除该小程序下已保存的本地缓存文件\n##### removeSavedFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### unzip(options) @unzip\n解压文件\n##### unzip HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| zipFilePath | - |\n@| targetPath | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### getSavedFileList(options) @getsavedfilelist\n获取该已保存的本地缓存文件列表\n##### getSavedFileList HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### GetSavedFileListResult 的属性值 @getsavedfilelistresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| fileList | - |\n\n\n#### truncate(options) @truncate\n对文件内容进行截断操作\n##### truncate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| length | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### truncateSync(filePath, length?) @truncatesync\n对文件内容进行截断操作 (truncate 的同步版本)\n##### truncateSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| filePath | - |\n| length | - | \n\n\n#### readCompressedFile(options) @readcompressedfile\n读取指定压缩类型的本地文件内容\n##### readCompressedFile HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| compressionAlgorithm | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### ReadCompressedFileResult 的属性值 @readcompressedfileresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| data | - |\n\n\n#### readCompressedFileSync(filePath, compressionAlgorithm) @readcompressedfilesync\n同步读取指定压缩类型的本地文件内容\n##### readCompressedFileSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| filePath | - |\n| compressionAlgorithm | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| string |\n \n\n#### open(options) @open\n打开文件，返回文件描述符\n##### open HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| flag | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### OpenFileSuccessResult 的属性值 @openfilesuccessresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| fd | - |\n\n\n#### openSync(options) @opensync\n同步打开文件，返回文件描述符\n##### openSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| flag | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| string |\n \n\n#### write(options) @write\n写入文件\n##### write HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| fd | - |\n@| data | - |\n@| encoding | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### WriteResult 的属性值 @writeresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| bytesWritten | - |\n\n\n#### writeSync(options) @writesync\n同步写入文件\n##### writeSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| fd | - |\n@| data | - |\n@| encoding | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [WriteResult](#writeresult-values) |\n \n\n#### close(options) @close\n关闭文件\n##### close HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| fd | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### closeSync(options) @closesync\n同步关闭文件\n##### closeSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| fd | - | \n\n\n#### fstat(options) @fstat\n获取文件的状态信息\n##### fstat HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| fd | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### FStatSuccessResult 的属性值 @fstatsuccessresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| stats | - |\n\n\n#### fstatSync(options) @fstatsync\n同步获取文件的状态信息\n##### fstatSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| fd | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [Stats](#stats-values) |\n \n\n#### ftruncate(options) @ftruncate\n对文件内容进行截断操作\n##### ftruncate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| fd | - |\n@| length | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### ftruncateSync(options) @ftruncatesync\n同步对文件内容进行截断操作\n##### ftruncateSync HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| fd | - |\n@| length | - | \n\n\n#### readZipEntry(options) @readzipentry\n读取压缩包内的文件\n##### readZipEntry HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| filePath | - |\n@| encoding | - |\n@| entries | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### EntriesResult 的属性值 @entriesresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| result | - |\n\n \n", "tutorial": "" }, "getUniverifyManager": { "name": "## uni.getUniverifyManager() @getuniverifymanager", "description": "获取一键登录管理对象", "compatibility": "### getUniverifyManager HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [UniverifyManager](#univerifymanager-values) |\n\n#### UniverifyManager 的方法 @univerifymanager-values \n\n#### preLogin(options) @prelogin\n预登录\n##### preLogin HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### PreLoginFail 的属性值 @preloginfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n\n#### login(options) @login\n登录\n##### login HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| univerifyStyle | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### LoginSuccess 的属性值 @loginsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| openId | - |\n| accessToken | - |\n\n###### LoginFail 的属性值 @loginfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n\n#### close() @close\n关闭登录页\n##### close HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### isPreLoginValid() @ispreloginvalid\n预登录是否有效\n##### isPreLoginValid HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| boolean |\n \n \n", "tutorial": "" }, "getFacialRecognitionMetaInfo": { "name": "## uni.getFacialRecognitionMetaInfo() @getfacialrecognitionmetainfo", "description": "获取阿里云实人认证meta info", "compatibility": "### getFacialRecognitionMetaInfo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| string |\n \n", "tutorial": "" }, "startFacialRecognitionVerify": { "name": "## uni.startFacialRecognitionVerify(faceStyle) @startfacialrecognitionverify", "description": "启动人脸识别", "compatibility": "### startFacialRecognitionVerify HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| faceStyle | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| certifyId | - |\n@| progressBarColor | - |\n@| screenOrientation | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### StartFacialRecognitionVerifySuccess 的属性值 @startfacialrecognitionverifysuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| errMsg | - |\n| cause | - |\n\n##### IFacialRecognitionVerifyError 的属性值 @ifacialrecognitionverifyerror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "createRewardedVideoAd": { "name": "## uni.createRewardedVideoAd(option) @createrewardedvideoad", "description": "创建激励视频广告对象", "compatibility": "### createRewardedVideoAd HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| option | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| adpid | - |\n@| urlCallback | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [RewardedVideoAd](#rewardedvideoad-values) |\n\n#### RewardedVideoAd 的方法 @rewardedvideoad-values \n\n#### show() @show\n广告加载成功之后，调用此方法展示广告\n##### show HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Promise\\ |\n \n\n#### load() @load\n加载广告\n##### load HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| Promise\\ |\n \n\n#### destroy() @destroy\n销毁广告\n##### destroy HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### onLoad(callback) @onload\n绑定广告 load 事件的监听器\n##### onLoad HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### offLoad(callback) @offload\n解除绑定 load 事件的监听器\n##### offLoad HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onError(callback) @onerror\n绑定 error 事件的监听器\n##### onError HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### IUniAdError 的属性值 @iuniaderror-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n\n\n#### offError(callback) @offerror\n解除绑定 error 事件的监听器\n##### offError HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onClose(callback) @onclose\n绑定 close 事件的监听器\n##### onClose HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n###### VideoAdClose 的属性值 @videoadclose-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| isEnded | - |\n\n\n#### offClose(callback) @offclose\n解除绑定 close 事件的监听器\n##### offClose HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onAdClicked(callback) @onadclicked\n绑定广告可点击屏幕区域事件的监听器\n##### onAdClicked HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n\n#### onVerify(callback) @onverify\n绑定 verify 事件的监听器\n##### onVerify HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| callback | - | \n\n \n", "tutorial": "" }, "requestPayment": { "name": "## uni.requestPayment(options) @requestpayment", "description": "请求支付", "compatibility": "### requestPayment HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| provider | - |\n@| orderInfo | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### RequestPaymentSuccess 的属性值 @requestpaymentsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| data | - |\n\n##### IRequestPaymentFail 的属性值 @irequestpaymentfail-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errCode | - |\n| errSubject | - |\n| data | - |\n| cause | - |\n| errMsg | - |\n", "returnValue": "", "tutorial": "" }, "canvasToTempFilePath": { "name": "## uni.canvasToTempFilePath(options, componentInstance) @canvastotempfilepath", "description": "把当前画布指定区域的内容导出生成指定大小的图片
", "compatibility": "### canvasToTempFilePath HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| x | - |\n@| y | - |\n@| width | - |\n@| height | - |\n@| destWidth | - |\n@| destHeight | - |\n@| canvasId | - |\n@| fileType | - |\n@| quality | - |\n@| success | - |\n@| fail | - |\n@| complete | - |\n| componentInstance | - | \n\n##### CanvasToTempFilePathSuccess 的属性值 @canvastotempfilepathsuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| tempFilePath | - |\n", "returnValue": "", "tutorial": "" }, "canvasGetImageData": { "name": "## uni.canvasGetImageData(options) @canvasgetimagedata", "description": "描述 canvas 区域隐含的像素数据", "compatibility": "### canvasGetImageData HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| canvasId | - |\n@| x | - |\n@| y | - |\n@| width | - |\n@| height | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n##### CanvasGetImageDataSuccess 的属性值 @canvasgetimagedatasuccess-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| errMsg | - |\n| width | - |\n| height | - |\n| data | - |\n", "returnValue": "", "tutorial": "" }, "canvasPutImageData": { "name": "## uni.canvasPutImageData(options) @canvasputimagedata", "description": "将像素数据绘制到画布", "compatibility": "### canvasPutImageData HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| canvasId | - |\n@| data | - |\n@| x | - |\n@| y | - |\n@| width | - |\n@| height | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n", "returnValue": "", "tutorial": "" }, "createWebviewContext": { "name": "## uni.createWebviewContext(webviewId, component?) @createwebviewcontext", "description": "创建 web-view 组件的上下文对象，用于操作 web-view 的行为。", "compatibility": "### createWebviewContext HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| webviewId | - |\n| component | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| [WebviewContext](#webviewcontext-values) \\| null | 否 |\n\n#### WebviewContext 的方法 @webviewcontext-values \n\n#### back() @back\n后退到 web-view 组件网页加载历史的上一页，如果不存在上一页则没有任何效果。\n##### back HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### forward() @forward\n前进到 web-view 组件网页加载历史的下一页，如果不存在下一页则没有任何效果。\n##### forward HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### reload() @reload\n重新加载 web-view 组件当前页面。\n##### reload HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### stop() @stop\n停止加载 web-view 组件当前网页，该方法不能阻止已经加载的 html 文档，但是能够阻止未完成的图片及延迟加载的资源。\n##### stop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### evalJS(js) @evaljs\n在网页中执行指定的js脚本，在 uvue 页面中可通过此方法向 web-view 组件加载的页面发送数据\n##### evalJS HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| js | - | \n\n \n", "tutorial": "" }, "createVideoContext": { "name": "## uni.createVideoContext(videoId, component?) @createvideocontext", "description": "创建并返回 video 上下文 videoContext 对象", "compatibility": "### createVideoContext HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| videoId | - |\n| component | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 | 必备 |\n| :- | :- |\n| [VideoContext](#videocontext-values) \\| null | 否 |\n\n#### VideoContext 的方法 @videocontext-values \n\n#### play() @play\n播放\n##### play HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n\n\n#### pause() @pause\n暂停\n##### pause HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n\n\n#### seek(position) @seek\n跳转到指定位置\n##### seek HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| position | - | \n\n\n#### stop() @stop\n停止视频\n##### stop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n\n\n#### sendDanmu(danmu) @senddanmu\n发送弹幕\n##### sendDanmu HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| danmu | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| text | - |\n@| color | - |\n@| time | - | \n\n\n#### playbackRate(rate) @playbackrate\n设置倍速播放\n##### playbackRate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| rate | - | \n\n\n#### requestFullScreen(direction?) @requestfullscreen\n进入全屏\n##### requestFullScreen HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| direction | - | \n\n\n#### exitFullScreen() @exitfullscreen\n退出全屏\n##### exitFullScreen HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n\n\n \n", "tutorial": "" }, "createMapContext": { "name": "## uni.createMapContext(mapId, currentComponent?) @createmapcontext", "description": "创建并返回 map 上下文 mapContext 对象
", "compatibility": "### createMapContext HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| x |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| mapId | - |\n| currentComponent | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [MapContext](#mapcontext-values) |\n\n#### MapContext 的方法 @mapcontext-values \n\n#### getCenterLocation(options) @getcenterlocation\n获取当前地图中心的经纬度，返回的是 gcj02 坐标系，可以用于 uni.openLocation\n##### getCenterLocation HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### LocationObject 的属性值 @locationobject-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| latitude | - |\n| longitude | - |\n\n\n#### moveToLocation(options) @movetolocation\n将地图中心移动到当前定位点，需要配合map组件的show-location使用\n##### moveToLocation HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| latitude | - |\n@| longitude | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### translateMarker(options) @translatemarker\n平移marker，带动画\n##### translateMarker HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| markerId | - |\n@| destination | - |\n@| autoRotate | - |\n@| rotate | - |\n@| moveWithRotate | - |\n@| duration | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### MapContextTranslateMarkerOptions 的方法 @mapcontexttranslatemarkeroptions-values \n\n###### animationEnd(result) @animationend\n动画结束回调函数\n###### animationEnd HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| result | - | \n\n\n\n#### includePoints(options) @includepoints\n缩放视野展示所有经纬度\n##### includePoints HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| points | - |\n@| padding | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### getRegion(options) @getregion\n获取当前地图的视野范围\n##### getRegion HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### MapContextGetRegionResult 的属性值 @mapcontextgetregionresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| southwest | - |\n| northeast | - |\n\n\n#### getScale(options) @getscale\n获取当前地图的缩放级别\n##### getScale HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n###### MapContextGetScaleResult 的属性值 @mapcontextgetscaleresult-values \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| scale | - |\n\n\n#### addCustomLayer(options) @addcustomlayer\n添加个性化图层\n##### addCustomLayer HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| layerId | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### addGroundOverlay(options) @addgroundoverlay\n创建自定义图片图层，图片会随着地图缩放而缩放\n##### addGroundOverlay HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| id | - |\n@| src | - |\n@| bounds | - |\n@| visible | - |\n@| zIndex | - |\n@| opacity | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### addMarkers(options) @addmarkers\n添加 marker\n##### addMarkers HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| markers | - |\n@| clear | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### fromScreenLocation(options) @fromscreenlocation\n获取屏幕上的点对应的经纬度，坐标原点为地图左上角\n##### fromScreenLocation HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| x | - |\n@| y | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### initMarkerCluster(options) @initmarkercluster\n初始化点聚合的配置，未调用时采用默认配置\n##### initMarkerCluster HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| enableDefaultStyle | - |\n@| zoomOnClick | - |\n@| gridSize | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### moveAlong(options) @movealong\n沿指定路径移动 marker，用于轨迹回放等场景。动画完成时触发回调事件，若动画进行中，对同一 marker 再次调用 moveAlong 方法，前一次的动画将被打断。\n##### moveAlong HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| markerId | - |\n@| path | - |\n@| autoRotate | - |\n@| duration | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### openMapApp(options) @openmapapp\n拉起地图APP选择导航。\n##### openMapApp HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| destination | - |\n@| latitude | - |\n@| longitude | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### removeCustomLayer(options) @removecustomlayer\n移除个性化图层\n##### removeCustomLayer HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| layerId | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### removeGroundOverlay(options) @removegroundoverlay\n移除自定义图片图层\n##### removeGroundOverlay HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| id | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### removeMarkers(options) @removemarkers\n移除 marker\n##### removeMarkers HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| markerIds | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### setCenterOffset(options) @setcenteroffset\n设置地图中心点偏移，向后向下为增长，屏幕比例范围(0.25~0.75)，默认偏移为[0.5, 0.5\\]\n##### setCenterOffset HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| offset | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### toScreenLocation(options) @toscreenlocation\n获取经纬度对应的屏幕坐标，坐标原点为地图左上角。\n##### toScreenLocation HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| latitude | - |\n@| longitude | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### updateGroundOverlay(options) @updategroundoverlay\n更新自定义图片图层。\n##### updateGroundOverlay HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| options | - |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| id | - |\n@| src | - |\n@| bounds | - |\n@| visible | - |\n@| zIndex | - |\n@| opacity | - |\n@| success | - |\n@| fail | - |\n@| complete | - | \n\n\n#### on(event, callback) @on\n监听地图事件。\n##### on HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| event | - |\n| callback | - | \n\n\n#### $getAppMap() @$getappmap\n获取原生地图对象 plus.maps.Map\n##### $getAppMap HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| any |\n \n \n", "tutorial": "" }, "createCanvasContext": { "name": "## uni.createCanvasContext(canvasId, componentInstance) @createcanvascontext", "description": "创建 canvas 绘图上下文
", "compatibility": "### createCanvasContext HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| 4.24 |\n", "param": "#### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| canvasId | - |\n| componentInstance | - | \n", "returnValue": "### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [CanvasContext](#canvascontext-values) |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| fillStyle | - |\n@| strokeStyle | - |\n@| shadowBlur | - |\n@| shadowColor | - |\n@| shadowOffsetX | - |\n@| shadowOffsetY | - |\n@| lineWidth | - |\n@| lineCap | - |\n@| lineJoin | - |\n@| miterLimit | - |\n@| globalAlpha | - |\n@| globalCompositeOperation | - |\n@| lineDashOffset | - |\n@| font | - |\n#### CanvasContext 的方法 @canvascontext-values \n\n#### setFillStyle(color) @setfillstyle\n设置填充色\n##### setFillStyle HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| color | - | \n\n###### CanvasGradient 的方法 @canvasgradient-values \n\n###### addColorStop(stop, color) @addcolorstop\n添加颜色的渐变点\n###### addColorStop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| stop | - |\n| color | - | \n\n\n\n#### setStrokeStyle(color) @setstrokestyle\n设置边框颜色\n##### setStrokeStyle HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| color | - | \n\n\n#### setShadow(offsetX?, offsetY?, blur?, color?) @setshadow\n设置阴影样式\n##### setShadow HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| offsetX | - |\n| offsetY | - |\n| blur | - |\n| color | - | \n\n\n#### createLinearGradient(x0, y0, x1, y1) @createlineargradient\n创建一个线性的渐变颜色\n##### createLinearGradient HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x0 | - |\n| y0 | - |\n| x1 | - |\n| y1 | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [CanvasGradient](#canvasgradient-values) |\n \n\n#### createCircularGradient(x, y, r) @createcirculargradient\n创建一个圆形的渐变颜色\n##### createCircularGradient HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - |\n| r | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| [CanvasGradient](#canvasgradient-values) |\n \n\n#### addColorStop(stop, color) @addcolorstop\n创建一个颜色的渐变点\n##### addColorStop HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| stop | - |\n| color | - | \n\n\n#### setLineWidth(lineWidth) @setlinewidth\n设置线条的宽度\n##### setLineWidth HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| lineWidth | - | \n\n\n#### setLineCap(lineCap) @setlinecap\n设置线条的端点样式\n##### setLineCap HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| lineCap | - | \n\n\n#### setLineJoin(lineJoin) @setlinejoin\n设置线条的交点样式\n##### setLineJoin HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| lineJoin | - | \n\n\n#### setLineDash(pattern, offset) @setlinedash\n设置线条的宽度\n##### setLineDash HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| pattern | - |\n| offset | - | \n\n\n#### setMiterLimit(miterLimit) @setmiterlimit\n设置最大斜接长度\n##### setMiterLimit HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| miterLimit | - | \n\n\n#### rect(x, y, width, height) @rect\n创建一个矩形\n##### rect HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - |\n| width | - |\n| height | - | \n\n\n#### fillRect(x, y, width, height) @fillrect\n填充一个矩形\n##### fillRect HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - |\n| width | - |\n| height | - | \n\n\n#### strokeRect(x, y, width, height) @strokerect\n画一个矩形(非填充)\n##### strokeRect HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - |\n| width | - |\n| height | - | \n\n\n#### clearRect(x, y, width, height) @clearrect\n清除画布上在该矩形区域内的内容\n##### clearRect HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - |\n| width | - |\n| height | - | \n\n\n#### fill() @fill\n对当前路径中的内容进行填充\n##### fill HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### stroke() @stroke\n画出当前路径的边框\n##### stroke HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### beginPath() @beginpath\n开始创建一个路径\n##### beginPath HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### closePath() @closepath\n关闭一个路径\n##### closePath HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### moveTo(x, y) @moveto\n把路径移动到画布中的指定点，不创建线条\n##### moveTo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - | \n\n\n#### lineTo(x, y) @lineto\n增加一个新点，然后创建一条从上次指定点到目标点的线\n##### lineTo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - | \n\n\n#### arc(x, y, r, sAngle, eAngle, counterclockwise?) @arc\n画一条弧线\n##### arc HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - |\n| r | - |\n| sAngle | - |\n| eAngle | - |\n| counterclockwise | - | \n\n\n#### bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y) @beziercurveto\n创建三次方贝塞尔曲线路径\n##### bezierCurveTo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| cp1x | - |\n| cp1y | - |\n| cp2x | - |\n| cp2y | - |\n| x | - |\n| y | - | \n\n\n#### quadraticCurveTo(cpx, cpy, x, y) @quadraticcurveto\n创建二次贝塞尔曲线路径\n##### quadraticCurveTo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| cpx | - |\n| cpy | - |\n| x | - |\n| y | - | \n\n\n#### scale(scaleWidth, scaleHeight) @scale\n横纵坐标缩放\n##### scale HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| scaleWidth | - |\n| scaleHeight | - | \n\n\n#### rotate(rotate) @rotate\n顺时针旋转当前坐标轴\n##### rotate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| rotate | - | \n\n\n#### translate(x, y) @translate\n对当前坐标系的原点(0, 0)进行变换\n##### translate HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x | - |\n| y | - | \n\n\n#### clip() @clip\n从原始画布中剪切任意形状和尺寸\n##### clip HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### setFontSize(fontSize) @setfontsize\n设置字体的字号\n##### setFontSize HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| fontSize | - | \n\n\n#### fillText(text, x, y, maxWidth?) @filltext\n在画布上绘制被填充的文本\n##### fillText HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| text | - |\n| x | - |\n| y | - |\n| maxWidth | - | \n\n\n#### setTextAlign(align) @settextalign\n设置文字的对齐\n##### setTextAlign HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| align | - | \n\n\n#### setTextBaseline(textBaseline) @settextbaseline\n设置文字的水平对齐\n##### setTextBaseline HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| textBaseline | - | \n\n\n#### drawImage(imageResource, dx?, dy?, dWidth?, dHeigt?, sx?, sy?, sWidth?, sHeight?) @drawimage\n绘制图像到画布\n##### drawImage HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| imageResource | - |\n| dx | - |\n| dy | - |\n| dWidth | - |\n| dHeigt | - |\n| sx | - |\n| sy | - |\n| sWidth | - |\n| sHeight | - | \n\n\n#### setGlobalAlpha(alpha) @setglobalalpha\n设置全局画笔透明度\n##### setGlobalAlpha HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| alpha | - | \n\n\n#### save() @save\n保存当前的绘图上下文\n##### save HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### restore() @restore\n恢复之前保存的绘图上下文\n##### restore HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n\n\n#### draw(reserve?, callback?) @draw\n将之前在绘图上下文中的描述（路径、变形、样式）画到 canvas 中\n##### draw HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| reserve | - |\n| callback | - | \n\n\n#### measureText(text) @measuretext\n测量文本尺寸信息，目前仅返回文本宽度\n##### measureText HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| text | - | \n\n##### 返回值 HarmonyOS 兼容性 \n\n| 类型 |\n| :- |\n| **CanvasTextMetrics** |\n@| 名称 | HarmonyOS 兼容性 |\n@| :- | :- |\n@| width | - | \n\n#### arcTo(x1, y1, x2, y2, radius) @arcto\n根据控制点和半径绘制圆弧路径\n##### arcTo HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| x1 | - |\n| y1 | - |\n| x2 | - |\n| y2 | - |\n| radius | - | \n\n\n#### strokeText(text, x, y, maxWidth?) @stroketext\n给定的 (x, y) 位置绘制文本描边的方法\n##### strokeText HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| text | - |\n| x | - |\n| y | - |\n| maxWidth | - | \n\n\n#### createPattern(image, repetition) @createpattern\n对指定的图像创建模式的方法，可在指定的方向上重复元图像\n##### createPattern HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| image | - |\n| repetition | - | \n\n\n#### setTransform(scaleX, skewX, skewY, scaleY, translateX, translateY) @settransform\n使用矩阵重新设置（覆盖）当前变换的方法\n##### setTransform HarmonyOS 兼容性 \n| HarmonyOS |\n| :- |\n| - |\n\n###### 参数 HarmonyOS 兼容性 @parameters-harmony-compatibility \n\n| 名称 | HarmonyOS 兼容性 |\n| :- | :- |\n| scaleX | - |\n| skewX | - |\n| skewY | - |\n| scaleY | - |\n| translateX | - |\n| translateY | - | \n\n \n", "tutorial": "" }, "general_type": { "name": "## 通用类型\n", "param": "" } }