Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 d8adba08 编写于 作者: G Gloria
浏览文件
操作

Update docs against 20233+20617+20595+20318+20668 

Signed-off-by: wusongqing<wusongqing@huawei.com>
上级 67d5f551
展开全部 隐藏空白更改
内联 并排
Showing with 2236 addition and 1991 deletion
en/application-dev/device/sensor-guidelines.md
浏览文件 @ d8adba08
...@@ -31,12 +31,13 @@ For details about the APIs, see [Sensor](../reference/apis/js-apis-sensor.md). ...@@ -31,12 +31,13 @@ For details about the APIs, see [Sensor](../reference/apis/js-apis-sensor.md).
For details about how to configure a permission, see [Declaring Permissions](../security/accesstoken-guidelines.md). For details about how to configure a permission, see [Declaring Permissions](../security/accesstoken-guidelines.md).
2. Subscribe to data changes of a type of sensor. The following uses the acceleration sensor as an example. 2. Subscribe to data changes of a type of sensor. The following uses the acceleration sensor as an example.
```js ```ts
import sensor from "@ohos.sensor"; import sensor from "@ohos.sensor";
sensor.on(sensor.SensorId.ACCELEROMETER, function(data){
console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z); // Data is obtained. sensor.on(sensor.SensorId.ACCELEROMETER, function (data) {
console.info("Succeeded in obtaining data. x: " + data.x + "y: " + data.y + "z: " + data.z); // Data is obtained.
}); });
``` ```
...@@ -44,7 +45,7 @@ For details about the APIs, see [Sensor](../reference/apis/js-apis-sensor.md). ...@@ -44,7 +45,7 @@ For details about the APIs, see [Sensor](../reference/apis/js-apis-sensor.md).
3. Unsubscribe from sensor data changes. 3. Unsubscribe from sensor data changes.
```js ```ts
import sensor from "@ohos.sensor"; import sensor from "@ohos.sensor";
sensor.off(sensor.SensorId.ACCELEROMETER); sensor.off(sensor.SensorId.ACCELEROMETER);
``` ```
...@@ -53,10 +54,11 @@ For details about the APIs, see [Sensor](../reference/apis/js-apis-sensor.md). ...@@ -53,10 +54,11 @@ For details about the APIs, see [Sensor](../reference/apis/js-apis-sensor.md).
4. Subscribe to only one data change of a type of sensor. 4. Subscribe to only one data change of a type of sensor.
```js ```ts
import sensor from "@ohos.sensor"; import sensor from "@ohos.sensor";
sensor.once(sensor.SensorId.ACCELEROMETER, function(data) {
console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z); // Data is obtained. sensor.once(sensor.SensorId.ACCELEROMETER, function (data) {
console.info("Succeeded in obtaining data. x: " + data.x + "y: " + data.y + "z: " + data.z); // Data is obtained.
}); });
``` ```
...@@ -64,13 +66,14 @@ For details about the APIs, see [Sensor](../reference/apis/js-apis-sensor.md). ...@@ -64,13 +66,14 @@ For details about the APIs, see [Sensor](../reference/apis/js-apis-sensor.md).
If the API fails to be called, you are advised to use the **try/catch** statement to capture error information that may occur in the code. Example: If the API fails to be called, you are advised to use the **try/catch** statement to capture error information that may occur in the code. Example:
```js ```ts
import sensor from "@ohos.sensor"; import sensor from "@ohos.sensor";
try {
sensor.once(sensor.SensorId.ACCELEROMETER, function(data) { try {
console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z); // Data is obtained. sensor.once(sensor.SensorId.ACCELEROMETER, function (data) {
}); console.info("Succeeded in obtaining data. x: " + data.x + "y: " + data.y + "z: " + data.z); // Data is obtained.
} catch (error) { });
console.error("Get sensor data error. data:" + error.data, " msg:", error.message); } catch (error) {
} console.error(`Failed to get sensor data. Code: ${error.code}, message: ${error.message}`);
}
``` ```
en/application-dev/device/vibrator-guidelines.md
浏览文件 @ d8adba08
...@@ -78,8 +78,8 @@ This JSON file contains two attributes: **MetaData** and **Channels**. ...@@ -78,8 +78,8 @@ This JSON file contains two attributes: **MetaData** and **Channels**.
- **Channels** provides information about the vibration channel. It is a JSON array that holds information about each channel. It contains two attributes: **Parameters** and **Pattern**. - **Channels** provides information about the vibration channel. It is a JSON array that holds information about each channel. It contains two attributes: **Parameters** and **Pattern**.
- **Parameters** provides parameters related to the channel. Under it, **Index** indicates the channel ID. The value is fixed at **1** for a single channel. This parameter is mandatory. - **Parameters** provides parameters related to the channel. Under it, **Index** indicates the channel ID. The value is fixed at **1** for a single channel. This parameter is mandatory.
- **Pattern** indicates the vibration sequence. It is a JSON array. Under it, **Event** indicates a vibration event, which can be either of the following types: - **Pattern** indicates the vibration sequence. It is a JSON array. Under it, **Event** indicates a vibration event, which can be either of the following types:
- **transient**: short vibration - **transient**: short vibration
- **continuous**: long vibration - **continuous**: long vibration
The table below describes the parameters under **Event**. The table below describes the parameters under **Event**.
...@@ -105,170 +105,161 @@ The following requirements must be met: ...@@ -105,170 +105,161 @@ The following requirements must be met:
2. Start vibration with the specified effect and attribute. 2. Start vibration with the specified effect and attribute.
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
vibrator.startVibration({ // To use startVibration, you must configure the ohos.permission.VIBRATE permission. vibrator.startVibration({ // To use startVibration, you must configure the ohos.permission.VIBRATE permission.
type: 'time', type: 'time',
duration: 1000, duration: 1000,
}, { }, {
id: 0, id: 0,
usage: 'alarm' usage: 'alarm'
}, (error) => { }, (error) => {
if (error) { if (error) {
console.error('vibrate fail, error.code: ' + error.code + 'error.message: ', + error.message); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate a successful vibration.'); console.info('Succeed in starting vibration.');
}); });
} catch (err) { } catch (err) {
console.error('errCode: ' + err.code + ' ,msg: ' + err.message); console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
3. Stop vibration in the specified mode. 3. Stop vibration in the specified mode.
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
// Stop vibration in VIBRATOR_STOP_MODE_TIME mode. To use stopVibration, you must configure the ohos.permission.VIBRATE permission. // Stop vibration in VIBRATOR_STOP_MODE_TIME mode. To use stopVibration, you must configure the ohos.permission.VIBRATE permission.
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, function (error) { vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate successful.'); console.info('Succeeded in stopping vibration.');
}) })
} catch (err) { } catch (err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message); console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
4. Stop vibration in all modes. 4. Stop vibration in all modes.
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
// To use startVibration and stopVibration, you must configure the ohos.permission.VIBRATE permission. // To use startVibration and stopVibration, you must configure the ohos.permission.VIBRATE permission.
try { try {
vibrator.startVibration({ vibrator.startVibration({
type: 'time', type: 'time',
duration: 1000, duration: 1000,
}, { }, {
id: 0, id: 0,
usage: 'alarm' usage: 'alarm'
}, (error) => { }, (error) => {
if (error) { if (error) {
console.error('vibrate fail, error.code: ' + error.code + 'error.message: ', + error.message); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate a successful vibration.'); console.info('Succeed in starting vibration');
}); });
// Stop vibration in all modes. // Stop vibration in all modes.
vibrator.stopVibration(function (error) { vibrator.stopVibration(function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate successful.'); console.info('Succeed in stopping vibration');
}) })
} catch (error) { } catch (error) {
console.info('errCode: ' + error.code + ' ,msg: ' + error.message); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
``` ```
5. Check whether the passed effect ID is supported. 5. Check whether the passed effect ID is supported.
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
// Check whether 'haptic.clock.timer' is supported. // Check whether 'haptic.clock.timer' is supported.
vibrator.isSupportEffect('haptic.clock.timer', function (err, state) { vibrator.isSupportEffect('haptic.clock.timer', function (err, state) {
if (err) { if (err) {
console.error('isSupportEffect failed, error:' + JSON.stringify(err)); console.error(`Failed to query effect. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
console.log('The effectId is ' + (state ? 'supported' : 'unsupported')); console.info('Succeed in querying effect');
if (state) { if (state) {
try { try {
vibrator.startVibration({ // To use startVibration, you must configure the ohos.permission.VIBRATE permission. vibrator.startVibration({ // To use startVibration, you must configure the ohos.permission.VIBRATE permission.
type: 'preset', type: 'preset',
effectId: 'haptic.clock.timer', effectId: 'haptic.clock.timer',
count: 1, count: 1,
}, { }, {
usage: 'unknown' usage: 'unknown'
}, (error) => { }, (error) => {
if(error) { if (error) {
console.error('haptic.clock.timer vibrator error:' + JSON.stringify(error)); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('haptic.clock.timer vibrator success'); console.info('Succeed in starting vibration');
} }
}); });
} catch (error) { } catch (error) {
console.error('Exception in, error:' + JSON.stringify(error)); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
} }
}) })
} catch (error) { } catch (error) {
console.error('Exception in, error:' + JSON.stringify(error)); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
``` ```
6. Start and stop custom vibration. 6. Start and stop custom vibration.
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
import resourceManager from '@ohos.resourceManager';
const FILE_NAME = "xxx.json"; const FILE_NAME = "xxx.json";
async function openResource(fileName) {
let fileDescriptor = undefined;
let mgr = await resourceManager.getResourceManager();
await mgr.getRawFd(fileName).then(value => {
fileDescriptor = {fd: value.fd, offset: value.offset, length: value.length};
console.log('openResource success fileName: ' + fileName);
}).catch(error => {
console.log('openResource err: ' + error);
});
return fileDescriptor;
}
async function closeResource(fileName) {
let mgr = await resourceManager.getResourceManager();
await mgr.closeRawFd(fileName).then(()=> {
console.log('closeResource success fileName: ' + fileName);
}).catch(error => {
console.log('closeResource err: ' + error);
});
}
// Obtain the file descriptor of the vibration configuration file. // Obtain the file descriptor of the vibration configuration file.
let rawFd = openResource(FILE_NAME); let fileDescriptor = undefined;
getContext().resourceManager.getRawFd(FILE_NAME).then(value => {
fileDescriptor = { fd: value.fd, offset: value.offset, length: value.length };
console.info('Succeed in getting resource file descriptor');
}).catch(error => {
console.error(`Failed to get resource file descriptor. Code: ${error.code}, message: ${error.message}`);
});
// To use startVibration and stopVibration, you must configure the ohos.permission.VIBRATE permission. // To use startVibration and stopVibration, you must configure the ohos.permission.VIBRATE permission.
try { try {
// Start custom vibration. // Start custom vibration.
vibrator.startVibration({ vibrator.startVibration({
type: "file", type: "file",
hapticFd: { fd: rawFd.fd, offset: rawFd.offset, length: rawFd.length } hapticFd: { fd: fileDescriptor.fd, offset: fileDescriptor.offset, length: fileDescriptor.length }
}, { }, {
usage: "alarm" usage: "alarm"
}).then(() => { }).then(() => {
console.info('startVibration success'); console.info('Succeed in starting vibration');
}, (error) => { }, (error) => {
console.info('startVibration error'); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
}); });
// Stop vibration in all modes. // Stop vibration in all modes.
vibrator.stopVibration(function (error) { vibrator.stopVibration(function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate successful.'); console.info('Succeed in stopping vibration');
}) })
} catch (error) { } catch (error) {
console.info('errCode: ' + error.code + ' ,msg: ' + error.message); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
// Close the vibration configuration file. // Close the vibration file.
closeResource(FILE_NAME); getContext().resourceManager.closeRawFd(FILE_NAME).then(() => {
console.info('Succeed in closing resource file descriptor');
}).catch(error => {
console.error(`Failed to close resource file descriptor. Code: ${error.code}, message: ${error.message}`);
});
``` ```
en/application-dev/reference/apis/js-apis-sensor.md
浏览文件 @ d8adba08
因为 它太大了无法显示 source diff 。你可以改为 查看blob。
en/application-dev/reference/apis/js-apis-system-vibrate.md
浏览文件 @ d8adba08
...@@ -26,7 +26,7 @@ Triggers device vibration. ...@@ -26,7 +26,7 @@ Triggers device vibration.
**Required permissions**: ohos.permission.VIBRATE **Required permissions**: ohos.permission.VIBRATE
**System capability**: SystemCapability.Sensors.MiscDevice **System capability**: SystemCapability.Sensors.MiscDevice.Lite
**Parameters** **Parameters**
...@@ -36,17 +36,17 @@ Triggers device vibration. ...@@ -36,17 +36,17 @@ Triggers device vibration.
**Example** **Example**
```js ```ts
vibrator.vibrate({ vibrator.vibrate({
mode: 'short', mode: 'short',
success: function() { success: function() {
console.log('vibrate is successful'); console.info('Succeed in vibrating');
}, },
fail: function(data, code) { fail: function(data, code) {
console.log("vibrate is failed, data: " + data + ", code: " + code); console.info(`Failed to vibrate. Data: ${data}, code: ${code}`);
}, },
complete: function() { complete: function() {
console.log('vibrate is completed'); console.info('completed in vibrating');
} }
}); });
``` ```
...@@ -57,7 +57,7 @@ Defines the vibration options. ...@@ -57,7 +57,7 @@ Defines the vibration options.
**Required permissions**: ohos.permission.VIBRATE **Required permissions**: ohos.permission.VIBRATE
**System capability**: SystemCapability.Sensors.MiscDevice **System capability**: SystemCapability.Sensors.MiscDevice.Lite
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | -------- | ---- | ------------------------------------------------------------ | | -------- | -------- | ---- | ------------------------------------------------------------ |
......
en/application-dev/reference/apis/js-apis-vibrator.md
浏览文件 @ d8adba08
...@@ -9,7 +9,7 @@ The **vibrator** module provides APIs for starting or stopping vibration. ...@@ -9,7 +9,7 @@ The **vibrator** module provides APIs for starting or stopping vibration.
## Modules to Import ## Modules to Import
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
``` ```
...@@ -41,24 +41,25 @@ For details about the error codes, see [Vibrator Error Codes](../errorcodes/erro ...@@ -41,24 +41,25 @@ For details about the error codes, see [Vibrator Error Codes](../errorcodes/erro
**Example** **Example**
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
vibrator.startVibration({ vibrator.startVibration({
type: 'time', type: 'time',
duration: 1000, duration: 1000,
}, { }, {
id: 0, id: 0,
usage: 'alarm' usage: 'alarm'
}, (error) => { }, (error) => {
if (error) { if (error) {
console.error('Vibrate fail, error.code: ' + error.code + 'error.message: ', + error.message); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate a successful vibration.'); console.info('Succeed in starting vibration');
}); });
} catch (err) { } catch (err) {
console.error('errCode: ' + err.code + ' ,msg: ' + err.message); console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
...@@ -95,24 +96,25 @@ For details about the error codes, see [Vibrator Error Codes](../errorcodes/erro ...@@ -95,24 +96,25 @@ For details about the error codes, see [Vibrator Error Codes](../errorcodes/erro
**Example** **Example**
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
vibrator.startVibration({ vibrator.startVibration({
type: 'time', type: 'time',
duration: 1000 duration: 1000
}, { }, {
id: 0, id: 0,
usage: 'alarm' usage: 'alarm'
}).then(() => { }).then(() => {
console.log('Promise returned to indicate a successful vibration'); console.info('Succeed in starting vibration');
}, (error) => { }, (error) => {
console.error('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
}); });
} catch (err) { } catch (err) {
console.error('errCode: ' + err.code + ' ,msg: ' + err.message); console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
## vibrator.stopVibration<sup>9+</sup> ## vibrator.stopVibration<sup>9+</sup>
...@@ -133,40 +135,41 @@ Stops vibration in the specified mode. This API uses an asynchronous callback to ...@@ -133,40 +135,41 @@ Stops vibration in the specified mode. This API uses an asynchronous callback to
**Example** **Example**
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
// Start vibration at a fixed duration. // Start vibration at a fixed duration.
vibrator.startVibration({ vibrator.startVibration({
type: 'time', type: 'time',
duration: 1000, duration: 1000,
}, { }, {
id: 0, id: 0,
usage: 'alarm' usage: 'alarm'
}, (error) => { }, (error) => {
if (error) { if (error) {
console.error('Vibrate fail, error.code: ' + error.code + 'error.message: ', + error.message); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate a successful vibration.'); console.info('Succeed in starting vibration');
}); });
} catch (err) { } catch (err) {
console.error('errCode: ' + err.code + ' ,msg: ' + err.message); console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`);
} }
try { try {
// Stop vibration in VIBRATOR_STOP_MODE_TIME mode. // Stop vibration in VIBRATOR_STOP_MODE_TIME mode.
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, function (error) { vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate successful.'); console.info('Succeed in stopping vibration');
}) })
} catch (err) { } catch (err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message); console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
## vibrator.stopVibration<sup>9+</sup> ## vibrator.stopVibration<sup>9+</sup>
...@@ -192,36 +195,37 @@ Stops vibration in the specified mode. This API uses a promise to return the res ...@@ -192,36 +195,37 @@ Stops vibration in the specified mode. This API uses a promise to return the res
**Example** **Example**
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
// Start vibration at a fixed duration. // Start vibration at a fixed duration.
vibrator.startVibration({ vibrator.startVibration({
type: 'time', type: 'time',
duration: 1000 duration: 1000
}, { }, {
id: 0, id: 0,
usage: 'alarm' usage: 'alarm'
}).then(() => { }).then(() => {
console.log('Promise returned to indicate a successful vibration'); console.info('Succeed in starting vibration');
}, (error) => { }, (error) => {
console.error('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
}); });
} catch (err) { } catch (err) {
console.error('errCode: ' + err.code + ' ,msg: ' + err.message); console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`);
} }
try { try {
// Stop vibration in VIBRATOR_STOP_MODE_TIME mode. // Stop vibration in VIBRATOR_STOP_MODE_TIME mode.
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(() => { vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(() => {
console.log('Promise returned to indicate a successful vibration.'); console.info('Succeed in stopping vibration');
}, (error) => { }, (error) => {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`);
}); });
} catch (err) { } catch (err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message); console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
## vibrator.stopVibration<sup>10+</sup> ## vibrator.stopVibration<sup>10+</sup>
...@@ -241,40 +245,41 @@ Stops vibration in all modes. This API uses an asynchronous callback to return t ...@@ -241,40 +245,41 @@ Stops vibration in all modes. This API uses an asynchronous callback to return t
**Example** **Example**
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
// Start vibration at a fixed duration. // Start vibration at a fixed duration.
vibrator.startVibration({ vibrator.startVibration({
type: 'time', type: 'time',
duration: 1000, duration: 1000,
}, { }, {
id: 0, id: 0,
usage: 'alarm' usage: 'alarm'
}, (error) => { }, (error) => {
if (error) { if (error) {
console.error('Vibrate fail, error.code: ' + error.code + 'error.message: ', + error.message); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate a successful vibration.'); console.info('Succeed in starting vibration');
}); });
} catch (error) { } catch (error) {
console.error('errCode: ' + error.code + ' ,msg: ' + error.message); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
try { try {
// Stop vibration in all modes. // Stop vibration in all modes.
vibrator.stopVibration(function (error) { vibrator.stopVibration(function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`);
return; return;
} }
console.log('Callback returned to indicate successful.'); console.info('Succeed in stopping vibration');
}) })
} catch (error) { } catch (error) {
console.info('errCode: ' + error.code + ' ,msg: ' + error.message); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
``` ```
## vibrator.stopVibration<sup>10+</sup> ## vibrator.stopVibration<sup>10+</sup>
...@@ -294,36 +299,37 @@ Stops vibration in all modes. This API uses a promise to return the result. ...@@ -294,36 +299,37 @@ Stops vibration in all modes. This API uses a promise to return the result.
**Example** **Example**
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
// Start vibration at a fixed duration. // Start vibration at a fixed duration.
vibrator.startVibration({ vibrator.startVibration({
type: 'time', type: 'time',
duration: 1000 duration: 1000
}, { }, {
id: 0, id: 0,
usage: 'alarm' usage: 'alarm'
}).then(() => { }).then(() => {
console.log('Promise returned to indicate a successful vibration'); console.info('Succeed in starting vibration');
}, (error) => { }, (error) => {
console.error('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
}); });
} catch (error) { } catch (error) {
console.error('errCode: ' + error.code + ' ,msg: ' + error.message); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
try { try {
// Stop vibration in all modes. // Stop vibration in all modes.
vibrator.stopVibration().then(() => { vibrator.stopVibration().then(() => {
console.log('Promise returned to indicate a successful vibration.'); console.info('Succeed in stopping vibration');
}, (error) => { }, (error) => {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`);
}); });
} catch (error) { } catch (error) {
console.info('errCode: ' + error.code + ' ,msg: ' + error.message); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
``` ```
## vibrator.isSupportEffect<sup>10+</sup> ## vibrator.isSupportEffect<sup>10+</sup>
...@@ -342,40 +348,41 @@ Checks whether the passed effect ID is supported. This API uses an asynchronous ...@@ -342,40 +348,41 @@ Checks whether the passed effect ID is supported. This API uses an asynchronous
**Example** **Example**
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
// Check whether 'haptic.clock.timer' is supported. // Check whether 'haptic.clock.timer' is supported.
vibrator.isSupportEffect('haptic.clock.timer', function (err, state) { vibrator.isSupportEffect('haptic.clock.timer', function (err, state) {
if (err) { if (err) {
console.error('isSupportEffect failed, error:' + JSON.stringify(err)); console.error(`Failed to query effect. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
console.log('The effectId is ' + (state ? 'supported' : 'unsupported')); console.info('Succeed in querying effect');
if (state) { if (state) {
try { try {
vibrator.startVibration({ // To use startVibration, you must configure the ohos.permission.VIBRATE permission. vibrator.startVibration({ // To use startVibration, you must configure the ohos.permission.VIBRATE permission.
type: 'preset', type: 'preset',
effectId: 'haptic.clock.timer', effectId: 'haptic.clock.timer',
count: 1, count: 1,
}, { }, {
usage: 'unknown' usage: 'unknown'
}, (error) => { }, (error) => {
if(error) { if (error) {
console.error('haptic.clock.timer vibrator error:' + JSON.stringify(error)); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('haptic.clock.timer vibrator success'); console.info('Succeed in starting vibration');
} }
}); });
} catch (error) { } catch (error) {
console.error('Exception in, error:' + JSON.stringify(error)); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
} }
}) })
} catch (error) { } catch (error) {
console.error('Exception in, error:' + JSON.stringify(error)); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
``` ```
## vibrator.isSupportEffect<sup>10+</sup> ## vibrator.isSupportEffect<sup>10+</sup>
...@@ -399,36 +406,37 @@ Checks whether the passed effect ID is supported. This API uses a promise to ret ...@@ -399,36 +406,37 @@ Checks whether the passed effect ID is supported. This API uses a promise to ret
**Example** **Example**
```js ```ts
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
try { try {
// Check whether 'haptic.clock.timer' is supported. // Check whether 'haptic.clock.timer' is supported.
vibrator.isSupportEffect('haptic.clock.timer').then((state) => { vibrator.isSupportEffect('haptic.clock.timer').then((state) => {
console.log('The effectId is ' + (state ? 'supported' : 'unsupported')); console.info(`The query result is ${state}`);
if (state) { if (state) {
try { try {
vibrator.startVibration({ vibrator.startVibration({
type: 'preset', type: 'preset',
effectId: 'haptic.clock.timer', effectId: 'haptic.clock.timer',
count: 1, count: 1,
}, { }, {
usage: 'unknown' usage: 'unknown'
}).then(()=>{ }).then(() => {
console.log('Promise returned to indicate a successful vibration'); console.info('Succeed in starting vibration');
}).catch((error)=>{ }).catch((error) => {
console.error('Promise returned to indicate a failed vibration:' + JSON.stringify(error)); console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`);
}); });
} catch (error) { } catch (error) {
console.error('Exception in, error:' + JSON.stringify(error)); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
} }
}, (error) => { }, (error) => {
console.error('isSupportEffect failed, error:' + JSON.stringify(error)); console.error(`Failed to query effect. Code: ${error.code}, message: ${error.message}`);
}) })
} catch (error) { } catch (error) {
console.error('Exception in, error:' + JSON.stringify(error)); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
} }
``` ```
## EffectId ## EffectId
...@@ -489,7 +497,7 @@ Describes the vibration with a preset effect. ...@@ -489,7 +497,7 @@ Describes the vibration with a preset effect.
## VibrateFromFile<sup>10+</sup> ## VibrateFromFile<sup>10+</sup>
Describes the custom vibration type, which is supported only by certain devices. Describes the custom vibration type, which is supported only by certain devices. If a device does not support this vibration type, [an error code indicating unsupported device](../errorcodes/errorcode-universal.md) is returned.
**System capability**: SystemCapability.Sensors.MiscDevice **System capability**: SystemCapability.Sensors.MiscDevice
...@@ -565,13 +573,13 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sta ...@@ -565,13 +573,13 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sta
**Example** **Example**
```js ```ts
vibrator.vibrate(1000).then(() => { vibrator.vibrate(1000).then(() => {
console.log('Promise returned to indicate a successful vibration.'); console.info('Succeed in vibrating');
}, (error) => { }, (error) => {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`);
}); });
``` ```
## vibrator.vibrate<sup>(deprecated)</sup> ## vibrator.vibrate<sup>(deprecated)</sup>
...@@ -594,15 +602,15 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sta ...@@ -594,15 +602,15 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sta
**Example** **Example**
```js ```ts
vibrator.vibrate(1000, function (error) { vibrator.vibrate(1000, function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('Callback returned to indicate a successful vibration.'); console.info('Succeed in vibrating');
} }
}) })
``` ```
## vibrator.vibrate<sup>(deprecated)</sup> ## vibrator.vibrate<sup>(deprecated)</sup>
...@@ -631,13 +639,13 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sta ...@@ -631,13 +639,13 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sta
**Example** **Example**
```js ```ts
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(() => { vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(() => {
console.log('Promise returned to indicate a successful vibration.'); console.info('Succeed in vibrating');
}, (error) => { }, (error) => {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`);
}); });
``` ```
## vibrator.vibrate<sup>(deprecated)</sup> ## vibrator.vibrate<sup>(deprecated)</sup>
...@@ -661,15 +669,15 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sta ...@@ -661,15 +669,15 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sta
**Example** **Example**
```js ```ts
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) { vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('Callback returned to indicate a successful vibration.'); console.info('Succeed in vibrating');
} }
}) })
``` ```
## vibrator.stop<sup>(deprecated)</sup> ## vibrator.stop<sup>(deprecated)</sup>
...@@ -697,22 +705,22 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sto ...@@ -697,22 +705,22 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sto
**Example** **Example**
```js ```ts
// Start vibration based on the specified effect ID. // Start vibration based on the specified effect ID.
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) { vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('Callback returned to indicate a successful vibration.'); console.info('Succeed in vibrating');
} }
}) })
// Stop vibration in VIBRATOR_STOP_MODE_PRESET mode. // Stop vibration in VIBRATOR_STOP_MODE_PRESET mode.
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(() => { vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(() => {
console.log('Promise returned to indicate a successful vibration.'); console.info('Succeed in stopping');
}, (error) => { }, (error) => {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to stop. Code: ${error.code}, message: ${error.message}`);
}); });
``` ```
## vibrator.stop<sup>(deprecated)</sup> ## vibrator.stop<sup>(deprecated)</sup>
...@@ -736,21 +744,21 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sto ...@@ -736,21 +744,21 @@ This API is deprecated since API version 9. You are advised to use [vibrator.sto
**Example** **Example**
```js ```ts
// Start vibration based on the specified effect ID. // Start vibration based on the specified effect ID.
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) { vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('Callback returned to indicate a successful vibration.'); console.info('Succeed in vibrating');
} }
}) })
// Stop vibration in VIBRATOR_STOP_MODE_PRESET mode. // Stop vibration in VIBRATOR_STOP_MODE_PRESET mode.
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function (error) { vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function (error) {
if (error) { if (error) {
console.log('error.code' + error.code + 'error.message' + error.message); console.error(`Failed to stop. Code: ${error.code}, message: ${error.message}`);
} else { } else {
console.log('Callback returned to indicate successful.'); onsole.info('Succeed in stopping');
} }
}) })
``` ```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或