From f8f8abe77c482bce5f62ba8d6ed16fcedfaf2318 Mon Sep 17 00:00:00 2001 From: bmeangel Date: Fri, 2 Sep 2022 17:30:29 +0800 Subject: [PATCH] update docs Signed-off-by: bmeangel --- .../reference/apis/js-apis-bluetooth.md | 15 +-- .../reference/apis/js-apis-inputmethod.md | 3 + .../apis/js-apis-inputmethodengine.md | 1 + .../reference/apis/js-apis-medialibrary.md | 15 ++- .../reference/apis/js-apis-screen-lock.md | 19 ++- .../reference/apis/js-apis-wifi.md | 108 +++++++++++++++++- .../reference/apis/js-apis-wifiext.md | 8 ++ 7 files changed, 152 insertions(+), 17 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-bluetooth.md b/zh-cn/application-dev/reference/apis/js-apis-bluetooth.md index c5fb36a047..5cd5b998af 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bluetooth.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bluetooth.md @@ -2061,9 +2061,8 @@ removeService(serviceUuid: string): boolean **返回值：** -| | | -| ------- | -------------------------- | | 类型 | 说明 | +| ------- | -------------------------- | | boolean | 删除服务操作，成功返回true，否则返回false。 | **示例：** @@ -2111,9 +2110,8 @@ server端特征值发生变化时，主动通知已连接的client设备。 **返回值：** -| | | -| ------- | ------------------------ | | 类型 | 说明 | +| ------- | ------------------------ | | boolean | 通知操作，成功返回true，否则返回false。 | **示例：** @@ -2156,9 +2154,8 @@ server端回复client端的读写请求。 **返回值：** -| | | -| ------- | -------------------------- | | 类型 | 说明 | +| ------- | -------------------------- | | boolean | 回复响应操作，成功返回true，否则返回false。 | **示例：** @@ -2786,9 +2783,8 @@ client端读取蓝牙低功耗设备特定服务的特征值。 **返回值：** -| | | -| ---------------------------------------- | -------------------------- | | 类型 | 说明 | +| ---------------------------------------- | -------------------------- | | Promise<[BLECharacteristic](#blecharacteristic)> | client读取特征值，通过promise形式获取。 | **示例：** @@ -2877,9 +2873,8 @@ client端读取蓝牙低功耗设备特定的特征包含的描述符。 **返回值：** -| | | -| ---------------------------------------- | -------------------------- | | 类型 | 说明 | +| ---------------------------------------- | -------------------------- | | Promise<[BLEDescriptor](#bledescriptor)> | client读取描述符，通过promise形式获取。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md index 45c5c83f69..dbee3a21b0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @@ -120,6 +120,7 @@ switchInputMethod(target: InputMethodProperty): Promise<boolean> |target | [InputmethodProperty](#inputmethodproperty8)| 是 | 传入要切换的目标输入法。 | **返回值：** + | 类型 | 说明 | | ----------------------------------------- | ---------------------------- | | Promise\ | 回调返回切换后的输入法。 | @@ -316,6 +317,7 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>) **系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------------------- | ---- | ---------------------- | | callback | Array<[InputMethodProperty](#inputmethodproperty8)> | 是 | 返回已安装输入法列表。 | @@ -343,6 +345,7 @@ listInputMethod(): Promise<Array<InputMethodProperty>> **系统能力**： SystemCapability.MiscServices.InputMethodFramework **返回值：** + | 类型 | 说明 | | ----------------------------------------------------------- | ---------------------- | | Promise> | 返回已安装输入法列表。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md index 4d413c3751..42474229dd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @@ -791,6 +791,7 @@ deleteBackward(length:number): Promise<boolean> **系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | length | number | 是 | 文本长度。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md index f558c70d9c..bbf27c4824 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -193,7 +193,7 @@ media.off('imageChange', () => { }) ``` -### createAsset 8+ +### createAsset8+ createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback<FileAsset>): void @@ -1529,7 +1529,7 @@ async function example() { ### deleteAsset8+ -deleteAsset(uri: string): Promise; +deleteAsset(uri: string): Promise\ 删除媒体文件资源 @@ -1545,6 +1545,11 @@ deleteAsset(uri: string): Promise; | -------- | ---------------------------- | ---- | --------------- | | uri | string | 是 | 需要删除的媒体文件资源的uri | +**返回值：** +| 类型 | 说明 | +| ------------------- | -------------------- | +| Promise<void> | Promise回调返回删除的结果。 | + **示例：** ```js @@ -1571,7 +1576,8 @@ async function example() { } ``` -deleteAsset(uri: string, callback: AsyncCallback): void; +### deleteAsset8+ +deleteAsset(uri: string, callback: AsyncCallback\): void 删除媒体文件资源 @@ -1585,7 +1591,8 @@ deleteAsset(uri: string, callback: AsyncCallback): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------- | ---- | --------------- | -| uri | string | 是 | 需要删除的媒体文件资源的uri | +| uri | string | 是 | 需要删除的媒体文件资源的uri。 | +|callback |AsyncCallback\| 是 |回调函数，用于获取删除的结果。| **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-screen-lock.md b/zh-cn/application-dev/reference/apis/js-apis-screen-lock.md index 6a45bdf035..d7bad749f4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-screen-lock.md +++ b/zh-cn/application-dev/reference/apis/js-apis-screen-lock.md @@ -22,12 +22,13 @@ isScreenLocked(callback: AsyncCallback<boolean>): void **系统能力**: SystemCapability.MiscServices.ScreenLock -**参数**： +**参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | 是 | 回调函数，返回true表示屏幕已锁屏，返回false表示屏幕未锁屏。 | -**示例**： +**示例：** ```js screenlock.isScreenLocked((err, data)=>{ @@ -49,6 +50,7 @@ isScreenLocked(): Promise<boolean> **系统能力**: SystemCapability.MiscServices.ScreenLock **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<boolean> | 以Promise形式返回结果。 | @@ -76,6 +78,7 @@ isSecureMode(callback: AsyncCallback<boolean>): void **参数**： + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示屏幕处于安全模式下，返回false表示屏幕当前不在安全模式下。 | @@ -102,6 +105,7 @@ isSecureMode(): Promise<boolean> **系统能力**: SystemCapability.MiscServices.ScreenLock **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<boolean> | 以Promise形式返回结果。 | @@ -129,6 +133,7 @@ unlockScreen(callback: AsyncCallback<void>): void **参数**： + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<void> | 是 | 回调函数，失败时返回错误信息。 | @@ -155,6 +160,7 @@ unlockScreen(): Promise<void> **系统能力**: SystemCapability.MiscServices.ScreenLock **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 以Promise形式返回结果。 | @@ -183,6 +189,7 @@ lockScreen(callback: AsyncCallback<void>): void **系统API**：此接口为系统接口，三方应用不支持调用。 **参数**： + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<void> | 是 | 回调函数，失败时返回错误信息。 | @@ -210,6 +217,7 @@ lockScreen(): Promise<void> **系统API**：此接口为系统接口，三方应用不支持调用。 **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 以Promise形式返回结果。 | @@ -236,6 +244,7 @@ on(type: 'beginWakeUp' | 'endWakeUp' | 'beginScreenOn' | 'endScreenOn' | 'beginS **系统API**：此接口为系统接口，三方应用不支持调用。 **参数**： + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。
- type为"beginWakeUp"，表示事件开始时开始唤醒。
- type为"endWakeUp"，表示事件结束时结束唤醒。
- type为"beginScreenOn"，表示事件开始时开始亮屏。
- type为"endScreenOn"，表示事件结束时结束亮屏。
- type为"beginScreenOff"，表示事件开始时开始灭屏。
- type为"endScreenOff"，表示事件结束时结束灭屏。
- type为"unlockScreen"，表示请求解锁。
- type为"beginExitAnimation"，表示动画开始退场。 | @@ -260,6 +269,7 @@ on(type: 'beginSleep' | 'endSleep' | 'changeUser', callback: Callback\) **系统API**：此接口为系统接口，三方应用不支持调用。 **参数**： + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。
- type为"beginSleep"，表示开始休眠。
- type为"endSleep"，表示结束休眠。
- type为"changeUser"，表示切换用户。 | @@ -283,6 +293,7 @@ on(type: 'screenlockEnabled', callback: Callback\): void **系统API**：此接口为系统接口，三方应用不支持调用。 **参数**： + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。
- type为"screenlockEnabled"，表示锁屏是否启用。 | @@ -308,6 +319,7 @@ off(type: 'beginWakeUp' | 'endWakeUp' | 'beginScreenOn' | 'endScreenOn' | 'begin **系统API**：此接口为系统接口，三方应用不支持调用。 **参数**： + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。
- type为"beginWakeUp"，表示事件开始时开始唤醒。
- type为"endWakeUp"，表示事件结束时结束唤醒。
- type为"beginScreenOn"，表示事件开始时开始亮屏。
- type为"endScreenOn"，表示事件结束时结束亮屏。
- type为"beginScreenOff"，表示事件开始时开始灭屏。
- type为"endScreenOff"，表示事件结束时结束灭屏。
- type为"unlockScreen"，表示请求解锁。
- type为"beginExitAnimation"，表示动画开始退场。
- type为"screenlockEnabled"，表示锁屏是否启用。
- type为"beginSleep"，表示开始休眠。
- type为"endSleep"，表示结束休眠。
- type为"changeUser"，表示切换用户。 | @@ -332,6 +344,7 @@ sendScreenLockEvent(event: String, parameter: number, callback: AsyncCallback\- "unlockScreenResult"，表示解锁结果。
- "screenDrawDone"，表示屏幕绘制完成。 | @@ -357,12 +370,14 @@ sendScreenLockEvent(event: String, parameter: number): Promise\ **系统API**：此接口为系统接口，三方应用不支持调用。 **参数**： + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | event | String | 是 | 事件类型，支持如下取值:
- "unlockScreenResult"，表示解锁结果。
- "screenDrawDone"，表示屏幕绘制完成。 | | parameter | number | 是 | 解锁状态。
- parameter为0，表示解锁成功。
- parameter为1，表示解锁失败。
- parameter为2，表示解锁取消。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise\ | 以Promise形式返回执行结果。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifi.md b/zh-cn/application-dev/reference/apis/js-apis-wifi.md index 25b830f81e..cf42efa5d2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifi.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifi.md @@ -24,6 +24,7 @@ enableWifi(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。| @@ -42,6 +43,7 @@ disableWifi(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。| @@ -58,6 +60,7 @@ isWifiActive(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:已使能， false:未使能。 | @@ -74,6 +77,7 @@ scan(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:扫描操作执行成功， false:扫描操作执行失败。 | @@ -90,6 +94,7 @@ getScanInfos(): Promise<Array<WifiScanInfo>> **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | Promise对象。返回扫描到的热点列表。 | @@ -106,6 +111,7 @@ getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | 是 | 回调函数。当成功时，err为0，data为扫描到的热点；否则err为非0值，data为空。 | @@ -159,6 +165,7 @@ WLAN热点信息。 **系统能力：** SystemCapability.Communication.WiFi.STA + | **参数名** | **类型** | **读写属性** | **说明** | | -------- | -------- | -------- | -------- | | ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 | @@ -181,6 +188,7 @@ WLAN热点信息。 **系统能力：** SystemCapability.Communication.WiFi.Core + | **名称** | **默认值** | **说明** | | -------- | -------- | -------- | | WIFI_SEC_TYPE_INVALID | 0 | 无效加密类型。 | @@ -203,6 +211,7 @@ WLAN热点信息。 **系统能力：** SystemCapability.Communication.WiFi.STA + | **参数名** | **类型** | **读写属性** | **说明** | | -------- | -------- | -------- | -------- | | eid | number | 只读 | 元素ID。 | @@ -215,6 +224,7 @@ WLAN热点信息。 **系统能力：** SystemCapability.Communication.WiFi.STA + | **名称** | **默认值** | **说明** | | -------- | -------- | -------- | | WIDTH_20MHZ | 0 | 20MHZ。 | @@ -236,6 +246,7 @@ getScanInfosSync():  Array<[WifiScanInfo](#wifiscaninfo)> **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | |  Array<[WifiScanInfo](#wifiscaninfo)> | 扫描结果数组。 | @@ -254,11 +265,13 @@ addDeviceConfig(config: WifiDeviceConfig): Promise<number> **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | Promise<number> | Promise对象。返回添加的网络配置ID，如果值为-1表示添加失败。 | @@ -269,6 +282,7 @@ WLAN配置信息。 **系统能力：** SystemCapability.Communication.WiFi.STA + | **参数名** | **类型** | **读写属性** | **说明** | | -------- | -------- | -------- | -------- | | ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 | @@ -294,6 +308,7 @@ WLAN配置信息。 **系统能力：** SystemCapability.Communication.WiFi.STA + | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | STATIC | 0 | 静态IP。 | @@ -396,6 +411,7 @@ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>) **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | @@ -413,11 +429,13 @@ addUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | Promise<boolean> | Promise对象。表示操作结果，true: 成功， false: 失败。 | @@ -434,6 +452,7 @@ addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean& **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | @@ -451,11 +470,13 @@ removeUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | Promise<boolean> | Promise对象。表示操作结果，true: 成功， false: 失败。 | @@ -472,6 +493,7 @@ removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boole **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | @@ -489,11 +511,13 @@ addCandidateConfig(config: WifiDeviceConfig): Promise<number> **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | Promise<number> | Promise对象。表示网络配置ID。 | @@ -510,6 +534,7 @@ addCandidateConfig(config: WifiDeviceConfig, callback: AsyncCallback<number&g **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | @@ -527,11 +552,13 @@ removeCandidateConfig(networkId: number): Promise<void> **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | networkId | number | 是 | 网络配置ID。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | Promise<void> | Promise对象。 | @@ -548,6 +575,7 @@ removeCandidateConfig(networkId: number, callback: AsyncCallback<void>): v **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | networkId | number | 是 | 网络配置ID。 | @@ -565,6 +593,7 @@ getCandidateConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | |  Array<[WifiDeviceConfig](#wifideviceconfig)> | 候选网络配置数组。 | @@ -581,6 +610,7 @@ connectToCandidateConfig(networkId: number): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | networkId | number | 是 | 候选网络配置的ID。 | @@ -599,11 +629,13 @@ connectToNetwork(networkId: number): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | networkId | number | 是 | 待连接的网络配置ID。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -623,11 +655,13 @@ connectToDevice(config: WifiDeviceConfig): boolean SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -647,6 +681,7 @@ disconnect(): boolean SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -662,13 +697,15 @@ getSignalLevel(rssi: number, band: number): number **系统能力：** SystemCapability.Communication.WiFi.STA -**参数：**： +**参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | rssi | number | 是 | 热点的信号强度(dBm)。 | | band | number | 是 | WLAN接入点的频段。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | number | 信号强度，取值范围为[0, 4]。 | @@ -685,6 +722,7 @@ getLinkedInfo(): Promise<WifiLinkedInfo> **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | 类型 | 说明 | | -------- | -------- | | Promise<[WifiLinkedInfo](#wifilinkedinfo)> | Promise对象。表示WLAN连接信息。 | @@ -701,6 +739,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiLinkedInfo](#wifilinkedinfo)> | 是 | 回调函数。当获取成功时，err为0，data表示WLAN连接信息。如果error为非0，表示处理出现错误。 | @@ -804,6 +843,7 @@ isConnected(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:已连接， false:未连接。 | @@ -822,6 +862,7 @@ getSupportedFeatures(): number **系统能力：** SystemCapability.Communication.WiFi.Core **返回值：** + | **类型** | **说明** | | -------- | -------- | | number | 支持的特性值。 | @@ -854,11 +895,13 @@ isFeatureSupported(featureId: number): boolean **参数：** + | **参数名** | **类型** | 必填 | **说明** | | -------- | -------- | -------- | -------- | | featureId | number | 是 | 特性ID值。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:支持， false:不支持。 | @@ -877,6 +920,7 @@ getDeviceMacAddress(): string[] **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | string[] | MAC地址。 | @@ -893,6 +937,7 @@ getIpInfo(): IpInfo **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | [IpInfo](#ipinfo7) | IP信息。 | @@ -926,6 +971,7 @@ getCountryCode(): string **系统能力：** SystemCapability.Communication.WiFi.Core **返回值：** + | **类型** | **说明** | | -------- | -------- | | string | 国家码。 | @@ -944,6 +990,7 @@ reassociate(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -962,6 +1009,7 @@ reconnect(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -980,6 +1028,7 @@ getDeviceConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | |  Array<[WifiDeviceConfig](#wifideviceconfig)> | 网络配置信息的数组。 | @@ -998,11 +1047,13 @@ updateNetwork(config: WifiDeviceConfig): number **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | number | 返回更新的网络配置ID，如果值为-1表示更新失败。 | @@ -1021,11 +1072,13 @@ disableNetwork(netId: number): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | netId | number | 是 | 网络配置ID。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -1044,6 +1097,7 @@ removeAllNetwork(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -1062,11 +1116,13 @@ removeDevice(id: number): boolean **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | id | number | 是 | 网络配置ID。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -1085,6 +1141,7 @@ enableHotspot(): boolean **系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。| @@ -1103,6 +1160,7 @@ disableHotspot(): boolean **系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。| @@ -1121,6 +1179,7 @@ isHotspotDualBandSupported(): boolean **系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:支持， false:不支持。| @@ -1139,6 +1198,7 @@ isHotspotActive(): boolean **系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:已使能， false:未使能。| @@ -1157,11 +1217,13 @@ setHotspotConfig(config: HotspotConfig): boolean **系统能力：** SystemCapability.Communication.WiFi.AP.Core **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [HotspotConfig](#hotspotconfig7) | 是 | 热点配置信息。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -1197,6 +1259,7 @@ getHotspotConfig(): HotspotConfig **系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** + | **类型** | **说明** | | -------- | -------- | | [HotspotConfig](#hotspotconfig7) | 热点的配置信息。 | @@ -1215,6 +1278,7 @@ getStations():  Array<[StationInfo](#stationinfo7)> **系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** + | **类型** | **说明** | | -------- | -------- | |  Array<[StationInfo](#stationinfo7)> | 连接的设备数组。 | @@ -1246,6 +1310,7 @@ getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo> **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** + | 类型 | 说明 | | -------- | -------- | | Promise<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | Promise对象。表示P2P连接信息。 | @@ -1288,6 +1353,7 @@ getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | 是 | 回调函数。当操作成功时，err为0，data表示P2P连接信息。如果error为非0，表示处理出现错误。 | @@ -1304,6 +1370,7 @@ getCurrentGroup(): Promise<WifiP2pGroupInfo> **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** + | 类型 | 说明 | | -------- | -------- | | Promise<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> | Promise对象。表示当前组信息。 | @@ -1320,6 +1387,7 @@ getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> | 是 | 回调函数。当操作成功时，err为0，data表示当前组信息。如果error为非0，表示处理出现错误。 | @@ -1336,6 +1404,7 @@ getP2pPeerDevices(): Promise<WifiP2pDevice[]> **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** + | 类型 | 说明 | | -------- | -------- | | Promise<[WifiP2pDevice[]](#wifip2pdevice8)> | Promise对象。表示对端设备列表信息。 | @@ -1352,6 +1421,7 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pDevice[]](#wifip2pdevice8)> | 是 | 回调函数。当操作成功时，err为0，data表示对端设备列表信息。如果error为非0，表示处理出现错误。 | @@ -1398,6 +1468,7 @@ getP2pLocalDevice(): Promise<WifiP2pDevice> **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** + | 类型 | 说明 | | -------- | -------- | | Promise<[WifiP2pDevice](#wifip2pdevice8)> | Promise对象。表示本端设备信息。 | @@ -1414,6 +1485,7 @@ getP2pLocalDevice(callback: AsyncCallback<WifiP2pDevice>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pDevice](#wifip2pdevice8)> | 是 | 回调函数。当操作成功时，err为0，data表示本端设备信息。如果error为非0，表示处理出现错误。 | @@ -1436,6 +1508,7 @@ createGroup(config: WifiP2PConfig): boolean | config | [WifiP2PConfig](#wifip2pconfig8) | 是 | 群组配置信息。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | boolean | true:创建群组操作执行成功， false:创建群组操作执行失败。 | @@ -1480,6 +1553,7 @@ removeGroup(): boolean **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** + | 类型 | 说明 | | -------- | -------- | | boolean | true:操作执行成功， false:操作执行失败。 | @@ -1497,11 +1571,13 @@ p2pConnect(config: WifiP2PConfig): boolean **参数：** + | **参数名** | **类型** | 必填 | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiP2PConfig](#wifip2pconfig8) | 是 | 连接配置信息。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | boolean | true:操作执行成功， false:操作执行失败。 | @@ -1585,6 +1661,7 @@ p2pCancelConnect(): boolean **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** + | 类型 | 说明 | | -------- | -------- | | boolean | true:操作执行成功， false:操作执行失败。 | @@ -1601,6 +1678,7 @@ startDiscoverDevices(): boolean **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** + | 类型 | 说明 | | -------- | -------- | | boolean | true:操作执行成功， false:操作执行失败。 | @@ -1617,6 +1695,7 @@ stopDiscoverDevices(): boolean **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** + | 类型 | 说明 | | -------- | -------- | | boolean | true:操作执行成功，操作执行失败。 | @@ -1634,11 +1713,13 @@ deletePersistentGroup(netId: number): boolean **参数：** + | **参数名** | **类型** | 必填 | **说明** | | -------- | -------- | -------- | -------- | | netId | number | 是 | 组的ID。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | boolean | true:操作执行成功，操作执行失败。 | @@ -1657,6 +1738,7 @@ getP2pGroups(): Promise<Array<WifiP2pGroupInfo>> **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** + | 类型 | 说明 | | -------- | -------- | | Promise< Array<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> > | Promise对象。表示所有群组信息。 | @@ -1692,6 +1774,7 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback< Array<[WifiP2pGroupInfo](#wifip2pgroupinfo8)>> | 是 | 回调函数。当操作成功时，err为0，data表示所有群组信息。如果error为非0，表示处理出现错误。 | @@ -1710,11 +1793,13 @@ setDeviceName(devName: string): boolean **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | devName | string | 是 | 设备名称。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | @@ -1731,6 +1816,7 @@ on(type: "wifiStateChange", callback: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiStateChange"字符串。 | @@ -1757,6 +1843,7 @@ off(type: "wifiStateChange", callback?: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiStateChange"字符串。 | @@ -1790,6 +1877,7 @@ on(type: "wifiConnectionChange", callback: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiConnectionChange"字符串。 | @@ -1814,6 +1902,7 @@ off(type: "wifiConnectionChange", callback?: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiConnectionChange"字符串。 | @@ -1831,6 +1920,7 @@ on(type: "wifiScanStateChange", callback: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiScanStateChange"字符串。 | @@ -1873,6 +1963,7 @@ on(type: "wifiRssiChange", callback: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiRssiChange"字符串。 | @@ -1890,6 +1981,7 @@ off(type: "wifiRssiChange", callback?: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiRssiChange"字符串。 | @@ -1907,6 +1999,7 @@ on(type: "hotspotStateChange", callback: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.AP.Core **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"hotspotStateChange"字符串。 | @@ -1933,6 +2026,7 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.AP.Core **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"hotspotStateChange"字符串。 | @@ -1950,6 +2044,7 @@ on(type: "p2pStateChange", callback: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pStateChange"字符串。 | @@ -1976,6 +2071,7 @@ off(type: "p2pStateChange", callback?: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pStateChange"字符串。 | @@ -1993,6 +2089,7 @@ on(type: "p2pConnectionChange", callback: Callback<WifiP2pLinkedInfo>): vo **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pConnectionChange"字符串。 | @@ -2010,6 +2107,7 @@ off(type: "p2pConnectionChange", callback?: Callback<WifiP2pLinkedInfo>): **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pConnectionChange"字符串。 | @@ -2027,6 +2125,7 @@ on(type: "p2pDeviceChange", callback: Callback<WifiP2pDevice>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pDeviceChange"字符串。 | @@ -2044,6 +2143,7 @@ off(type: "p2pDeviceChange", callback?: Callback<WifiP2pDevice>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pDeviceChange"字符串。 | @@ -2061,6 +2161,7 @@ on(type: "p2pPeerDeviceChange", callback: Callback<WifiP2pDevice[]>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 | @@ -2078,6 +2179,7 @@ off(type: "p2pPeerDeviceChange", callback?: Callback<WifiP2pDevice[]>): vo **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 | @@ -2095,6 +2197,7 @@ on(type: "p2pPersistentGroupChange", callback: Callback<void>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 | @@ -2112,6 +2215,7 @@ off(type: "p2pPersistentGroupChange", callback?: Callback<void>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 | @@ -2129,6 +2233,7 @@ on(type: "p2pDiscoveryChange", callback: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pDiscoveryChange"字符串。 | @@ -2153,6 +2258,7 @@ off(type: "p2pDiscoveryChange", callback?: Callback<number>): void **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** + | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pDiscoveryChange"字符串。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifiext.md b/zh-cn/application-dev/reference/apis/js-apis-wifiext.md index 9afdcf23bf..439e632951 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifiext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifiext.md @@ -23,6 +23,7 @@ enableHotspot(): boolean; **系统能力：** SystemCapability.Communication.WiFi.AP.Extension **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | 操作结果， true: 成功， false: 失败。 | @@ -39,6 +40,7 @@ disableHotspot(): boolean; **系统能力：** SystemCapability.Communication.WiFi.AP.Extension **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | 操作结果， true: 成功， false: 失败。 | @@ -55,6 +57,7 @@ getSupportedPowerModel(): Promise<Array<PowerModel>> **系统能力：** SystemCapability.Communication.WiFi.AP.Extension **返回值：** + | 类型 | 说明 | | -------- | -------- | | Promise<Array<[PowerModel](#powermodel)>> | Promise对象。表示功率模式。 | @@ -84,6 +87,7 @@ getSupportedPowerModel(callback: AsyncCallback<Array<PowerModel>>): **系统能力：** SystemCapability.Communication.WiFi.AP.Extension **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[PowerModel](#powermodel)> | 是 | 回调函数。当操作成功时，err为0，data表示支持的功率模式。如果error为非0，表示处理出现错误。 | @@ -100,6 +104,7 @@ getPowerModel(): Promise<PowerModel> **系统能力：** SystemCapability.Communication.WiFi.AP.Extension **返回值：** + | 类型 | 说明 | | -------- | -------- | | Promise<[PowerModel](#powermodel)> | Promise对象。表示功率模式。 | @@ -116,6 +121,7 @@ getPowerModel(callback: AsyncCallback<PowerModel>): void **系统能力：** SystemCapability.Communication.WiFi.AP.Extension **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[PowerModel](#powermodel)> | 是 | 回调函数。当操作成功时，err为0，data表示功率模式。如果error为非0，表示处理出现错误。 | @@ -132,11 +138,13 @@ setPowerModel(model: PowerModel) : boolean; **系统能力：** SystemCapability.Communication.WiFi.AP.Extension **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | model | AsyncCallback<[PowerModel](#powermodel)> | 是 | 功率模式。 | **返回值：** + | **类型** | **说明** | | -------- | -------- | | boolean | 操作结果， true: 成功， false: 失败。 | -- GitLab