提交 9c2b2ba4 编写于 作者: W wuzhihuitmac

add vibrate interce on api9

Signed-off-by: Nwuzhihuitmac <wuzhihui4@huawei.com>
Change-Id: I7dc075d817ec45c927de2d01202ae18b34cf7c68
上级 df6d4baa
...@@ -27,19 +27,20 @@ vibrate(duration: number): Promise&lt;void&gt; ...@@ -27,19 +27,20 @@ vibrate(duration: number): Promise&lt;void&gt;
**系统能力**:SystemCapability.Sensors.MiscDevice **系统能力**:SystemCapability.Sensors.MiscDevice
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------ | | -------- | ------ | ---- | ------------ |
| duration | number | 是 | 指示马达振动的持续时间。 | | duration | number | 是 | 指示马达振动的持续时间。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------- | | ------------------- | ----------- |
| Promise&lt;void&gt; | 指示触发振动是否成功。 | | Promise&lt;void&gt; | 指示触发振动是否成功。 |
**示例:** **示例:**
```js ```js
vibrator.vibrate(1000).then(()=>{ vibrator.vibrate(1000).then(()=>{
console.log("Promise returned to indicate a successful vibration."); console.log("Promise returned to indicate a successful vibration.");
...@@ -48,6 +49,44 @@ vibrate(duration: number): Promise&lt;void&gt; ...@@ -48,6 +49,44 @@ vibrate(duration: number): Promise&lt;void&gt;
}); });
``` ```
## vibrator.vibrate
vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
按照指定振动效果和振动属性触发马达振动。
**权限列表**:ohos.permission.VIBRATE,该权限为系统权限
**系统能力**:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------- | ---- | :------------- |
| effect | VibrateEffect | 是 | 马达振动效果。 |
| attribute | VibrateAttribute | 是 | 马达振动属性。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise&lt;void&gt; | Promise实例。 |
**示例:**
```js
vibrator.vibrate({
'type': 'time',
'duration': 1000
}, {
'id': 1,
'usage': 'alarm'
}).then((result)=>{
console.log("Promise returned to indicate a successful vibration");
}).catch((error)=>{
console.log("error.code"+error.code+"error.message"+error.message);
})
```
## vibrator.vibrate ## vibrator.vibrate
...@@ -124,6 +163,7 @@ vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void ...@@ -124,6 +163,7 @@ vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
| callback | AsyncCallback&lt;void&gt; | 否 | 马达执行振动的回调函数,指示触发振动是否成功。 | | callback | AsyncCallback&lt;void&gt; | 否 | 马达执行振动的回调函数,指示触发振动是否成功。 |
**示例:** **示例:**
```js ```js
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){ vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){
if(error){ if(error){
...@@ -134,6 +174,41 @@ vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void ...@@ -134,6 +174,41 @@ vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
}) })
``` ```
## vibrator.vibrate
vibrate(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback&lt;void&gt;): void
按照指定振动效果和振动属性触发马达振动。
**权限列表**:ohos.permission.VIBRATE,该权限为系统权限
**系统能力**:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | :----------------------- |
| effect | VibrateEffect | 是 | 马达振动效果。 |
| attribute | VibrateAttribute | 是 | 马达振动属性。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定的callback回调方法。 |
示例:
```js
vibrator.vibrate({
'type':'time',
'duration':1000,
},{
'id':1,
'usage': 'alarm'
}, (error)=>{
if(error){
console.log(TAG + " fail, error.code:"+error.code+",error.message:"+error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
}
});
```
## vibrator.stop ## vibrator.stop
...@@ -214,3 +289,32 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void; ...@@ -214,3 +289,32 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
| ------------------------- | -------- | ---------------------------------------- | | ------------------------- | -------- | ---------------------------------------- |
| VIBRATOR_STOP_MODE_TIME | "time" | 停止模式为duration模式的振动。即触发振动时参数类型为number,参数本身为指示振动持续时间的触发方式。 | | VIBRATOR_STOP_MODE_TIME | "time" | 停止模式为duration模式的振动。即触发振动时参数类型为number,参数本身为指示振动持续时间的触发方式。 |
| VIBRATOR_STOP_MODE_PRESET | "preset" | 停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId,参数本身为指示马达振动效果的字符串的触发方式。 | | VIBRATOR_STOP_MODE_PRESET | "preset" | 停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId,参数本身为指示马达振动效果的字符串的触发方式。 |
## VibrateTime
表示马达振动时间
| 名称 | 默认值 | 说明 |
| -------- | ------ | ------------------------ |
| type | "time" | 指定振动效果类型。 |
| duration | 100 | 指定振动效果的持续时间。 |
## VibratePreset
表示马达预置振动类型
| 名称 | 默认值 | 说明 |
| -------- | -------------------- | ------------------------------ |
| type | "preset" | 预置振动类型。 |
| effectId | "haptic.clock.timer" | 调整定时器时振动器的振动效果。 |
| count | 1 | 循环振动的次数。 |
## VibrateAttribute
表示马达振动属性
| 名称 | 默认值 | 说明 |
| ----- | --------- | ------------------------------------------------------------ |
| id | 123 | 振动器id。 |
| usage | "unknown" | 振动的使用。取值范围["unknown" , "alarm" , "ring" , "notification" , "communication" ]。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册