diff --git a/zh-cn/application-dev/device/vibrator-guidelines.md b/zh-cn/application-dev/device/vibrator-guidelines.md index 5028d5f8206278cc37b763dc2622e1cadf6b8915..3e7087421c8cf635a29f8d4c7c274edaf70cfc9b 100644 --- a/zh-cn/application-dev/device/vibrator-guidelines.md +++ b/zh-cn/application-dev/device/vibrator-guidelines.md @@ -8,20 +8,20 @@ ## 接口说明 -| 模块 | 接口名 | 描述 | -| -------- | -------- | -------- | -| ohos.vibrator | vibrate(duration: number): Promise<void> | 触发马达按照时长振动，Promise型。 | -| ohos.vibrator | vibrate(duration: number, callback?: AsyncCallback<void>): void | 触发马达按照时长振动，Callback型。 | -| ohos.vibrator | vibrate(effectId: EffectId): Promise<void> | 触发马达按照指定字符串振动，Promise型。 | -| ohos.vibrator | vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void | 触发马达按照指定字符串振动，Callback型。 | -| ohos.vibrator | stop(stopMode: VibratorStopMode): Promise<void> | 停止振动。 | -| ohos.vibrator | stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void | 停止振动。 | +| 模块 | 接口名 | 描述 | +| ------------- | ---------------------------------------- | ------------------------------- | +| ohos.vibrator | vibrate(duration: number): Promise<void> | 触发马达按照时长振动，使用Promise异步回调。 | +| ohos.vibrator | vibrate(duration: number, callback?: AsyncCallback<void>): void | 触发马达按照时长振动，使用Callback异步回调。 | +| ohos.vibrator | vibrate(effectId: EffectId): Promise<void> | 触发马达按照开发者传递效果振动，使用Promise异步回调。 | +| ohos.vibrator | vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void | 触发马达按照开发者传递效果振动，使用Callback异步回调。 | +| ohos.vibrator | stop(stopMode: VibratorStopMode): Promise<void> | 停止振动。 | +| ohos.vibrator | stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void | 停止振动。 | ## 开发步骤 1. 控制设备上的振动器，需要在“config.json”里面进行配置请求权限。具体如下： - + ``` ”reqPermissions“:[ { @@ -58,7 +58,7 @@ ``` 2. 触发设备振动。 - + ``` import vibrator from "@ohos.vibrator" vibrator.vibrate(1000).then((error)=>{ @@ -71,7 +71,7 @@ ``` 3. 停止设备振动。 - + ``` import vibrator from "@ohos.vibrator" vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then((error)=>{ diff --git a/zh-cn/application-dev/reference/apis/js-apis-appAccount.md b/zh-cn/application-dev/reference/apis/js-apis-appAccount.md index 7fb71c1da37fa5a62251781a727f447a785620fa..c9bf5b77ab2dba22d69508a6c65d24cba2e2667e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appAccount.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appAccount.md @@ -26,7 +26,7 @@ createAppAccountManager(): AppAccountManager **示例：** ```js - var appAccountManager = account.createAppAccountManager(); + var appAccountManager = account_appAccount.createAppAccountManager(); ``` ## AppAccountManager diff --git a/zh-cn/application-dev/reference/apis/js-apis-config-policy.md b/zh-cn/application-dev/reference/apis/js-apis-config-policy.md index f5ee4ad5d3c59daa2a826bc9b35aeaceae297206..a9c4752e3304c3c554582a7e666d63dd31e2c157 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-config-policy.md +++ b/zh-cn/application-dev/reference/apis/js-apis-config-policy.md @@ -1,14 +1,16 @@ # 配置策略 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> - 本模块接口均为系统接口，三方应用不支持调用。 +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> +> 本模块接口均为系统接口，三方应用不支持调用。 配置策略提供按预先定义的定制配置层级获取对应定制配置目录和文件路径的能力。 ## 导入模块 -``` +```js import configPolicy from '@ohos.configPolicy'; ``` @@ -22,18 +24,18 @@ getOneCfgFile(relPath: string, callback: AsyncCallback<string>): void **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | relPath | string | 是 | 配置文件名 | - | callback | AsyncCallback<string> | 是 | 异步回调，用于返回最高优先级配置文件的路径 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | --------------------- | +| relPath | string | 是 | 配置文件名 | +| callback | AsyncCallback<string> | 是 | 异步回调，用于返回最高优先级配置文件的路径 | **示例：** - ``` + ```js configPolicy.getOneCfgFile('config.xml', (error, value) => { if (error == undefined) { - console.log(value); + console.log("value is " + value); } else { - console.log(error); + console.log("error occurs "+ error); } }); ``` @@ -48,19 +50,19 @@ getOneCfgFile(relPath: string): Promise<string> **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | relPath | string | 是 | 配置文件名 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ----- | +| relPath | string | 是 | 配置文件名 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<string> | 最高优先级配置文件的路径 | +| 类型 | 说明 | +| --------------------- | ------------ | +| Promise<string> | 最高优先级配置文件的路径 | **示例：** - ``` + ```js configPolicy.getOneCfgFile('config.xml').then(value => { - console.log(value); + console.log("value is " + value); }).catch(error => { console.log("getOneCfgFile promise " + error); }); @@ -77,18 +79,18 @@ getCfgFiles(relPath: string, callback: AsyncCallback<Array<string>>) **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | relPath | string | 是 | 配置文件名 | - | callback | AsyncCallback<Array<string>> | 是 | 异步回调，用于返回文件列表 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------- | +| relPath | string | 是 | 配置文件名 | +| callback | AsyncCallback<Array<string>> | 是 | 异步回调，用于返回文件列表 | **示例：** - ``` + ```js configPolicy.getCfgFiles('config.xml', (error, value) => { if (error == undefined) { - console.log(value); + console.log("value is " + value); } else { - console.log(error); + console.log("error occurs "+ error); } }); ``` @@ -103,19 +105,19 @@ getCfgFiles(relPath: string): Promise<Array<string>> **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | relPath | string | 是 | 配置文件名 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ----- | +| relPath | string | 是 | 配置文件名 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<string>> | 文件列表 | +| 类型 | 说明 | +| ---------------------------------- | ---- | +| Promise<Array<string>> | 文件列表 | **示例：** - ``` + ```js configPolicy.getCfgFiles('config.xml').then(value => { - console.log(value); + console.log("value is " + value); }).catch(error => { console.log("getCfgFiles promise " + error); }); @@ -131,17 +133,17 @@ getCfgDirList(callback: AsyncCallback<Array<string>>): void **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<Array<string>> | 是 | 异步回调，用于返回配置层级目录列表 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ----------------- | +| callback | AsyncCallback<Array<string>> | 是 | 异步回调，用于返回配置层级目录列表 | **示例：** - ``` + ```js configPolicy.getCfgDirList((error, value) => { if (error == undefined) { - console.log(value); + console.log("value is " + value); } else { - console.log(error); + console.log("error occurs "+ error); } }); ``` @@ -156,14 +158,14 @@ getCfgDirList(): Promise<Array<string>> **系统能力**：SystemCapability.Customization.ConfigPolicy **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<string>> | 配置层级目录列表 | +| 类型 | 说明 | +| ---------------------------------- | -------- | +| Promise<Array<string>> | 配置层级目录列表 | **示例：** - ``` + ```js configPolicy.getCfgDirList().then(value => { - console.log(value); + console.log("value is " + value); }).catch(error => { console.log("getCfgDirList promise " + error); }); diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md index 5df98297bd52f9837e10872d76ca68e950290388..5b6bcd08d8ca7d4507400c95441047579ecdb606 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md @@ -4,14 +4,15 @@ 输入设备管理模块，用于监听输入设备连接、断开和变化，并查看输入设备相关信息。比如监听鼠标插拔，并获取鼠标的id、name和指针移动速度等信息。 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> **说明：** +> > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -``` +```js import inputDevice from '@ohos.multimodalInput.inputDevice'; ``` @@ -33,7 +34,7 @@ getDeviceIds(callback: AsyncCallback<Array<number>>): void **示例：** -``` +```js export default { data: { deviceIds: Array, @@ -65,7 +66,7 @@ function getDeviceIds(): Promise> **示例：** -``` +```js export default { testGetDeviceIds: function () { console.info("InputDeviceJsTest---start---testGetDeviceIds"); @@ -100,7 +101,7 @@ getDevice(deviceId: number, callback: AsyncCallback<InputDeviceData>): voi **示例：** -``` +```js export default { InputDeviceData: { deviceId : 0, @@ -136,7 +137,7 @@ function getDevice(deviceId: number): Promise **示例：** -``` +```js export default { InputDeviceData: { deviceId : 0, @@ -165,18 +166,18 @@ export default { **系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice -| 名称 | 参数类型 | 说明 | -| ---------- | -------------------------------------- | ------------------------------------------------------------ | -| id | number | 输入设备的唯一标识，同一个物理设备反复插拔，其设备id会发生变化。 | -| name | string | 输入设备的名字。 | +| 名称 | 参数类型 | 说明 | +| ---------- | -------------------------------------- | ---------------------------------------- | +| id | number | 输入设备的唯一标识，同一个物理设备反复插拔，其设备id会发生变化。 | +| name | string | 输入设备的名字。 | | sources | Array<[SourceType](#sourcetype)> | 输入设备支持的源类型。比如有的键盘上附带触摸板，则此设备有keyboard和touchpad两种输入源。 | -| axisRanges | Array<[axisRanges](#axisrange)> | 输入设备的轴信息。 | -| bus | number | 输入设备的总线类型。 | -| product | number | 输入设备的产品信息。 | -| vendor | number | 输入设备的厂商信息。 | -| version | number | 输入设备的版本信息。 | -| phys | string | 输入设备的物理地址。 | -| uniq | string | 输入设备的唯一标识。 | +| axisRanges | Array<[axisRanges](#axisrange)> | 输入设备的轴信息。 | +| bus | number | 输入设备的总线类型。 | +| product | number | 输入设备的产品信息。 | +| vendor | number | 输入设备的厂商信息。 | +| version | number | 输入设备的版本信息。 | +| phys | string | 输入设备的物理地址。 | +| uniq | string | 输入设备的唯一标识。 | ## AxisType diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md b/zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md index 5a06a6a68c97ac82d65443df0e822607ff7a6796..9b5ea5c1c5f77b6eecb9035331355170b3980826 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md @@ -1,17 +1,17 @@ # 注入按键 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> **说明：** > -> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > -> - 本模块接口均为系统接口，三方应用不支持调用。 +> 本模块接口均为系统接口，三方应用不支持调用。 ## 导入模块 -``` +```js import inputEventClient from '@ohos.multimodalInput.inputEventClient'; ``` @@ -26,20 +26,20 @@ injectEvent({KeyEvent: KeyEvent}): void **参数：** -| 参数 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| KeyEvent | [KeyEvent](#keyevent) | 是 | 注入按键的描述信息 | +| 参数 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | --------- | +| KeyEvent | [KeyEvent](#keyevent) | 是 | 注入按键的描述信息 | **示例：** -``` +```js let keyEvent = { isPressed: true, keyCode: 2, keyDownDuration: 0, isIntercepted: false } -res = inputEventClient.injectEvent({KeyEvent: keyEvent}); +let res = inputEventClient.injectEvent({KeyEvent: keyEvent}); ``` @@ -49,9 +49,9 @@ res = inputEventClient.injectEvent({KeyEvent: keyEvent}); **系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputSimulator -| 参数 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| isPressed | boolean | 是 | 按键是否按下 | -| keyCode | Number | 是 | 按键键值 | -| keyDownDuration | boolean | 是 | 按键按下持续时间 | -| isIntercepted | Number | 是 | 按键是否可以被拦截 | +| 参数 | 类型 | 必填 | 说明 | +| --------------- | ------- | ---- | --------- | +| isPressed | boolean | 是 | 按键是否按下 | +| keyCode | Number | 是 | 按键键值 | +| keyDownDuration | boolean | 是 | 按键按下持续时间 | +| isIntercepted | Number | 是 | 按键是否可以被拦截 |