Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 359b1e2e 编写于 作者: B bailu1992
浏览文件
操作

vibrate错误码整改-1 

Signed-off-by: Nbailu1992 <bailu27@huawei.com>
上级 9420bbd4
显示空白变更内容
内联 并排
Showing with 150 addition and 225 deletion
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
浏览文件 @ 359b1e2e
...@@ -13,11 +13,11 @@ vibrator模块提供控制马达振动的能力，如通过接口控制马达启 ...@@ -13,11 +13,11 @@ vibrator模块提供控制马达振动的能力，如通过接口控制马达启
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
``` ```
## vibrator.vibrate ## vibrator.startVibration<sup>9+</sup>
vibrate(duration: number): Promise&lt;void&gt; startVibration(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback&lt;void&gt;): void
按照指定持续时间触发马达振动。 按照指定振动效果和振动属性触发马达振动。
**需要权限**：ohos.permission.VIBRATE **需要权限**：ohos.permission.VIBRATE
...@@ -26,28 +26,36 @@ vibrate(duration: number): Promise&lt;void&gt; ...@@ -26,28 +26,36 @@ vibrate(duration: number): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- | | --------- | -------------------------------------- | ---- | :--------------------------------------------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 | | effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
**返回值：** | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：** 示例：
```js ```js
vibrator.vibrate(1000).then(()=>{ try {
console.log("Promise returned to indicate a successful vibration."); vibrator.startVibration({
type:'time',
duration:1000,
},{
id:0,
usage: 'alarm'
}, (error)=>{ }, (error)=>{
console.log("error.code"+error.code+"error.message"+error.message); if(error){
console.log("vibrate fail, error.code:" + error.code + ",error.message:" + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
}
}); });
``` } catch(err) {
console.info('off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## vibrator.vibrate<sup>9+</sup> ## vibrator.startVibration<sup>9+</sup>
vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt; startVibration(effect: VibrateEffect, attribute: VibrateAttribute): Promise<&it;void&it;>
按照指定振动效果和振动属性触发马达振动。 按照指定振动效果和振动属性触发马达振动。
...@@ -58,7 +66,7 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt; ...@@ -58,7 +66,7 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :------------- | | --------- | -------------------------------------- | ---- | -------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 | | effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 | | attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
...@@ -70,227 +78,213 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt; ...@@ -70,227 +78,213 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
vibrator.vibrate({ try {
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.log("Promise returned to indicate a successful vibration");
}).catch((error)=>{ }).catch((error)=>{
console.log("error.code" + error.code + "error.message" + error.message); console.log("error.code" + error.code + "error.message" + error.message);
}) })
``` } catch(err) {
console.info('off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## vibrator.vibrate ## vibrator.stopVibration<sup>9+</sup>
vibrate(duration: number, callback?: AsyncCallback&lt;void&gt;): void stopVibration(stopMode: VibratorStopMode, callback: AsyncCallback<&it;void&it;>): void
按照指定持续时间触发马达振动。 按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
**需要权限**：ohos.permission.VIBRATE **需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- | | -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| duration | number | 是 | 马达振动时长, 单位ms。 | | stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达停止振动成功，err为undefined，否则为错误对象。 |
**示例：** **示例：**
```js ```js
vibrator.vibrate(1000,function(error){ try {
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
if(error){ if(error){
console.log("error.code" + error.code + "error.message" + error.message); console.log("error.code" + error.code + "error.message" + error.message);
}else{ }else{
console.log("Callback returned to indicate a successful vibration."); console.log("Callback returned to indicate successful.");
} }
}) })
} catch(err) {
console.info('off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}
``` ```
## vibrator.stopVibration<sup>9+</sup>
## vibrator.vibrate stopVibration(stopMode: VibratorStopMode): Promise<&it;void&it;>
vibrate(effectId: EffectId): Promise&lt;void&gt;
按照预置振动效果触发马达振动。 按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
**需要权限**：ohos.permission.VIBRATE **需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------ | | -------- | ------------------------------------- | ---- | ------------------------ |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 | | stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------------------------- | | ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 | | Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{ try {
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log("Promise returned to indicate a successful vibration."); console.log("Promise returned to indicate a successful vibration.");
}, (error)=>{ }, (error)=>{
console.log("error.code" + error.code + "error.message" + error.message); console.log("error.code" + error.code + "error.message" + error.message);
}); });
} catch(err) {
console.info('off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}
``` ```
## vibrator.vibrate<sup>(deprecated)</sup>
## vibrator.vibrate vibrate(duration: number): Promise&lt;void&gt;
vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
按照指定振动效果触发马达振动。 按照指定持续时间触发马达振动。
**需要权限**：ohos.permission.VIBRATE **需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- | | -------- | ------ | ---- | ---------------------- |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 | | duration | number | 是 | 马达振动时长, 单位ms。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){ vibrator.vibrate(1000).then(()=>{
if(error){ console.log("Promise returned to indicate a successful vibration.");
console.log("error.code" + error.code + "error.message" + error.message); }, (error)=>{
}else{ console.log("error.code"+error.code+"error.message"+error.message);
console.log("Callback returned to indicate a successful vibration."); });
}
})
``` ```
## vibrator.vibrate<sup>9+</sup> ## vibrator.vibrate<sup>(deprecated)</sup>
vibrate(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback&lt;void&gt;): void vibrate(duration: number, callback?: AsyncCallback&lt;void&gt;): void
按照指定振动效果和振动属性触发马达振动。 按照指定持续时间触发马达振动。
**需要权限**：ohos.permission.VIBRATE **需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :--------------------------------------------------------- | | -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 | | duration | number | 是 | 马达振动时长, 单位ms。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
示例： **示例：**
```js ```js
vibrator.vibrate({ vibrator.vibrate(1000,function(error){
type:'time',
duration:1000,
},{
id:0,
usage: 'alarm'
}, (error)=>{
if(error){ if(error){
console.log("vibrate fail, error.code:" + error.code + ",error.message:" + error.message); console.log("error.code" + error.code + "error.message" + error.message);
}else{ }else{
console.log("Callback returned to indicate a successful vibration."); console.log("Callback returned to indicate a successful vibration.");
} }
}); })
``` ```
## vibrator.startVibration
startVibration(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback&lt;void&gt;): void ## vibrator.vibrate<sup>(deprecated)</sup>
按照指定振动效果和振动属性触发马达振动。 vibrate(effectId: EffectId): Promise&lt;void&gt;
按照预置振动效果触发马达振动。
**需要权限**：ohos.permission.VIBRATE **需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :--------------------------------------------------------- | | -------- | --------------------- | ---- | ------------------ |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 | | effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
示例： **返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
```js **示例：**
try { ```js
vibrator.startVibration({ vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{
type:'time', console.log("Promise returned to indicate a successful vibration.");
duration:1000,
},{
id:0,
usage: 'alarm'
}, (error)=>{ }, (error)=>{
if(error){ console.log("error.code" + error.code + "error.message" + error.message);
console.log("vibrate fail, error.code:" + error.code + ",error.message:" + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
}
}); });
} catch(err) { ```
console.info('off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## vibrator.startVibration
startVibration(effect: VibrateEffect, attribute: VibrateAttribute): Promise<&it;void&it;> ## vibrator.vibrate<sup>(deprecated)</sup>
按照指定振动效果和振动属性触发马达振动。 vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
按照指定振动效果触发马达振动。
**需要权限**：ohos.permission.VIBRATE **需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | -------------- | | -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 | | effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
try { vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){
vibrator.startVibration({ if(error){
type: 'time',
duration: 1000
}, {
id: 0,
usage: 'alarm'
}).then(()=>{
console.log("Promise returned to indicate a successful vibration");
}).catch((error)=>{
console.log("error.code" + error.code + "error.message" + error.message); console.log("error.code" + error.code + "error.message" + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
}
}) })
} catch(err) {
console.info('off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}
``` ```
## vibrator.stop ## vibrator.stop<sup>(deprecated)</sup>
stop(stopMode: VibratorStopMode): Promise&lt;void&gt; stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
...@@ -323,7 +317,7 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt; ...@@ -323,7 +317,7 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
``` ```
## vibrator.stop ## vibrator.stop<sup>(deprecated)</sup>
stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void
...@@ -351,75 +345,6 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void ...@@ -351,75 +345,6 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void
}) })
``` ```
## vibrator.stopVibration
stopVibration(stopMode: VibratorStopMode, callback: AsyncCallback<&it;void&it;>): void
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达停止振动成功，err为undefined，否则为错误对象。 |
**示例：**
```js
try {
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
if(error){
console.log("error.code" + error.code + "error.message" + error.message);
}else{
console.log("Callback returned to indicate successful.");
}
})
} catch(err) {
console.info('off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## vibrator.stopVibration
stopVibration(stopMode: VibratorStopMode): Promise<&it;void&it;>
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：**
```js
try {
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
}, (error)=>{
console.log("error.code" + error.code + "error.message" + error.message);
});
} catch(err) {
console.info('off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## EffectId ## EffectId
马达振动效果的字符串。 马达振动效果的字符串。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或