@doubao-apps/create 0.0.25 → 0.0.26

package/dist/template-starter/.ai/reference/open-api/12-device-/346/234/254/345/234/260/350/203/275/345/212/233.md

@@ -0,0 +1,1005 @@
+# Open API: Device / 本地能力
+
+剪贴板、电话、联系人、日历、扫码、屏幕、震动等系统能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
+| --- | --- | --- | --- | --- | --- |
+| [`sendSms`](#sendsms) | `sendSms(params?): Promise<object>` | 拉起系统短信发送面板 | `params?: SendSmsParams` | `Promise<object>` | - |
+| [`checkIsOpenAccessibility`](#checkisopenaccessibility) | `checkIsOpenAccessibility(params?): Promise<CheckIsOpenAccessibilityResult>` | 检测无障碍能力是否开启 | `params?` | `Promise<CheckIsOpenAccessibilityResult>` | - |
+| [`getBatteryInfo`](#getbatteryinfo) | `getBatteryInfo(params?): Promise<GetBatteryInfoResult>` | 获取电池信息 | `params?` | `Promise<GetBatteryInfoResult>` | - |
+| [`addPhoneCalendar`](#addphonecalendar) | `addPhoneCalendar(params): Promise<object>` | 向系统日历添加事件 | `params: AddPhoneCalendarParams` | `Promise<object>` | - |
+| [`addPhoneRepeatCalendar`](#addphonerepeatcalendar) | `addPhoneRepeatCalendar(params): Promise<object>` | 向系统日历添加重复事件 | `params: AddPhoneRepeatCalendarParams` | `Promise<object>` | - |
+| [`getClipboardData`](#getclipboarddata) | `getClipboardData(params?): Promise<GetClipboardDataResult>` | 获取剪贴板内容 | `params?` | `Promise<GetClipboardDataResult>` | - |
+| [`setClipboardData`](#setclipboarddata) | `setClipboardData(params): Promise<object>` | 设置系统剪贴板内容 | `params: SetClipboardDataParams` | `Promise<object>` | - |
+| [`chooseContact`](#choosecontact) | `chooseContact(params?): Promise<ChooseContactResult>` | 选择手机联系人 | `params?` | `Promise<ChooseContactResult>` | - |
+| [`addPhoneContact`](#addphonecontact) | `addPhoneContact(params): Promise<object>` | 添加手机联系人 | `params: AddPhoneContactParams` | `Promise<object>` | - |
+| [`getRandomValues`](#getrandomvalues) | `getRandomValues(params): Promise<GetRandomValuesResult>` | 获取安全随机数 | `params: GetRandomValuesParams` | `Promise<GetRandomValuesResult>` | - |
+| [`makePhoneCall`](#makephonecall) | `makePhoneCall(params): Promise<object>` | 拨打电话 | `params: MakePhoneCallParams` | `Promise<object>` | - |
+| [`scanCode`](#scancode) | `scanCode(params?): Promise<ScanCodeResult>` | 调起扫码能力 | `params?: ScanCodeParams` | `Promise<ScanCodeResult>` | - |
+| [`getScreenBrightness`](#getscreenbrightness) | `getScreenBrightness(params?): Promise<GetScreenBrightnessResult>` | 获取屏幕亮度 | `params?` | `Promise<GetScreenBrightnessResult>` | - |
+| [`setVisualEffectOnCapture`](#setvisualeffectoncapture) | `setVisualEffectOnCapture(params?): Promise<object>` | 设置截屏或录屏时的视觉表现 | `params?: SetVisualEffectOnCaptureParams` | `Promise<object>` | 控制截屏或录屏时的视觉效果 |
+| [`setScreenBrightness`](#setscreenbrightness) | `setScreenBrightness(params): Promise<object>` | 设置屏幕亮度 | `params: SetScreenBrightnessParams` | `Promise<object>` | - |
+| [`setKeepScreenOn`](#setkeepscreenon) | `setKeepScreenOn(params): Promise<object>` | 设置屏幕常亮状态 | `params: SetKeepScreenOnParams` | `Promise<object>` | - |
+| [`onUserCaptureScreen`](#onusercapturescreen) | `onUserCaptureScreen(handler): () => void` | 监听用户主动截屏事件 | `handler` | `() => void` | 返回取消监听函数 |
+| [`vibrateShort`](#vibrateshort) | `vibrateShort(params?): Promise<object>` | 触发短震动 | `params?: VibrateShortParams` | `Promise<object>` | - |
+| [`vibrateLong`](#vibratelong) | `vibrateLong(params?): Promise<object>` | 触发长震动 | `params?` | `Promise<object>` | - |
+
+## API 详情
+
+<a id="sendsms"></a>
+### sendSms()
+
+> **sendSms**(`params`?): `Promise`\<`object`\>
+
+拉起系统短信发送面板。
+
+#### Parameters
+
+• **params?**: [`SendSmsParams`](#sendsmsparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，在成功拉起短信发送面板时解析。
+
+#### Example
+
+```typescript
+import { sendSms } from '@doubao-apps/framework/api';
+
+await sendSms({
+  phoneNumber: '10086',
+  message: '查询话费'
+});
+```
+
+<a id="checkisopenaccessibility"></a>
+### checkIsOpenAccessibility()
+
+> **checkIsOpenAccessibility**(`params`?): `Promise`\<[`CheckIsOpenAccessibilityResult`](#checkisopenaccessibilityresult)\>
+
+检测无障碍能力是否开启。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`CheckIsOpenAccessibilityResult`](#checkisopenaccessibilityresult)\>
+
+<a id="getbatteryinfo"></a>
+### getBatteryInfo()
+
+> **getBatteryInfo**(`params`?): `Promise`\<[`GetBatteryInfoResult`](#getbatteryinforesult)\>
+
+获取电池信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetBatteryInfoResult`](#getbatteryinforesult)\>
+
+<a id="addphonecalendar"></a>
+### addPhoneCalendar()
+
+> **addPhoneCalendar**(`params`): `Promise`\<`object`\>
+
+向系统日历添加事件。
+
+#### Parameters
+
+• **params**: [`AddPhoneCalendarParams`](#addphonecalendarparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="addphonerepeatcalendar"></a>
+### addPhoneRepeatCalendar()
+
+> **addPhoneRepeatCalendar**(`params`): `Promise`\<`object`\>
+
+向系统日历添加重复事件。
+
+#### Parameters
+
+• **params**: [`AddPhoneRepeatCalendarParams`](#addphonerepeatcalendarparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getclipboarddata"></a>
+### getClipboardData()
+
+> **getClipboardData**(`params`?): `Promise`\<[`GetClipboardDataResult`](#getclipboarddataresult)\>
+
+获取剪贴板内容。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetClipboardDataResult`](#getclipboarddataresult)\>
+
+<a id="setclipboarddata"></a>
+### setClipboardData()
+
+> **setClipboardData**(`params`): `Promise`\<`object`\>
+
+设置系统剪贴板内容。
+
+#### Parameters
+
+• **params**: [`SetClipboardDataParams`](#setclipboarddataparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="choosecontact"></a>
+### chooseContact()
+
+> **chooseContact**(`params`?): `Promise`\<[`ChooseContactResult`](#choosecontactresult)\>
+
+选择手机联系人。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`ChooseContactResult`](#choosecontactresult)\>
+
+<a id="addphonecontact"></a>
+### addPhoneContact()
+
+> **addPhoneContact**(`params`): `Promise`\<`object`\>
+
+添加手机联系人。
+
+#### Parameters
+
+• **params**: [`AddPhoneContactParams`](#addphonecontactparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getrandomvalues"></a>
+### getRandomValues()
+
+> **getRandomValues**(`params`): `Promise`\<[`GetRandomValuesResult`](#getrandomvaluesresult)\>
+
+获取安全随机数。
+
+#### Parameters
+
+• **params**: [`GetRandomValuesParams`](#getrandomvaluesparams)
+
+#### Returns
+
+`Promise`\<[`GetRandomValuesResult`](#getrandomvaluesresult)\>
+
+<a id="makephonecall"></a>
+### makePhoneCall()
+
+> **makePhoneCall**(`params`): `Promise`\<`object`\>
+
+拨打电话。
+
+#### Parameters
+
+• **params**: [`MakePhoneCallParams`](#makephonecallparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="scancode"></a>
+### scanCode()
+
+> **scanCode**(`params`?): `Promise`\<[`ScanCodeResult`](#scancoderesult)\>
+
+调起扫码能力。
+
+#### Parameters
+
+• **params?**: [`ScanCodeParams`](#scancodeparams)
+
+#### Returns
+
+`Promise`\<[`ScanCodeResult`](#scancoderesult)\>
+
+<a id="getscreenbrightness"></a>
+### getScreenBrightness()
+
+> **getScreenBrightness**(`params`?): `Promise`\<[`GetScreenBrightnessResult`](#getscreenbrightnessresult)\>
+
+获取屏幕亮度。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetScreenBrightnessResult`](#getscreenbrightnessresult)\>
+
+<a id="setvisualeffectoncapture"></a>
+### setVisualEffectOnCapture()
+
+> **setVisualEffectOnCapture**(`params`?): `Promise`\<`object`\>
+
+设置截屏或录屏时的视觉表现。
+
+#### Parameters
+
+• **params?**: [`SetVisualEffectOnCaptureParams`](#setvisualeffectoncaptureparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+控制截屏或录屏时的视觉效果。
+
+<a id="setscreenbrightness"></a>
+### setScreenBrightness()
+
+> **setScreenBrightness**(`params`): `Promise`\<`object`\>
+
+设置屏幕亮度。
+
+#### Parameters
+
+• **params**: [`SetScreenBrightnessParams`](#setscreenbrightnessparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="setkeepscreenon"></a>
+### setKeepScreenOn()
+
+> **setKeepScreenOn**(`params`): `Promise`\<`object`\>
+
+设置屏幕常亮状态。
+
+#### Parameters
+
+• **params**: [`SetKeepScreenOnParams`](#setkeepscreenonparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="onusercapturescreen"></a>
+### onUserCaptureScreen()
+
+> **onUserCaptureScreen**(`handler`): () => `void`
+
+监听用户主动截屏事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onUserCaptureScreen } from '@doubao-apps/framework/api';
+
+const off = onUserCaptureScreen(() => {
+  console.log('用户截屏了');
+});
+
+off();
+```
+
+<a id="vibrateshort"></a>
+### vibrateShort()
+
+> **vibrateShort**(`params`?): `Promise`\<`object`\>
+
+触发短震动。
+
+#### Parameters
+
+• **params?**: [`VibrateShortParams`](#vibrateshortparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="vibratelong"></a>
+### vibrateLong()
+
+> **vibrateLong**(`params`?): `Promise`\<`object`\>
+
+触发长震动。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+## 相关类型
+
+<a id="sendsmsparams"></a>
+### SendSmsParams
+
+拉起系统短信发送面板的请求参数。
+
+#### Properties
+
+##### message?
+
+> `optional` **message**: `string`
+
+预填到发送短信面板的内容。
+
+##### phoneNumber?
+
+> `optional` **phoneNumber**: `string`
+
+预填到发送短信面板的手机号。
+
+<a id="checkisopenaccessibilityresult"></a>
+### CheckIsOpenAccessibilityResult
+
+无障碍能力检测结果。
+
+#### Properties
+
+##### open
+
+> **open**: `boolean`
+
+是否开启视觉无障碍能力。
+
+<a id="getbatteryinforesult"></a>
+### GetBatteryInfoResult
+
+电池信息。
+
+#### Properties
+
+##### isCharging
+
+> **isCharging**: `boolean`
+
+是否正在充电。
+
+##### level
+
+> **level**: `number`
+
+当前电量，范围 1 - 100。
+
+<a id="addphonecalendarparams"></a>
+### AddPhoneCalendarParams
+
+添加系统日历事件的请求参数。
+
+#### Extended by
+
+- [`AddPhoneRepeatCalendarParams`](#addphonerepeatcalendarparams)
+
+#### Properties
+
+##### alarm?
+
+> `optional` **alarm**: `boolean`
+
+是否提醒。
+
+##### alarmOffset?
+
+> `optional` **alarmOffset**: `number`
+
+提前提醒时间，单位秒。
+
+##### allDay?
+
+> `optional` **allDay**: `boolean`
+
+是否为全天事件。
+
+##### description?
+
+> `optional` **description**: `string`
+
+事件描述。
+
+##### endTime?
+
+> `optional` **endTime**: `number`
+
+结束时间的 Unix 秒级时间戳。
+
+##### location?
+
+> `optional` **location**: `string`
+
+事件位置。
+
+##### startTime
+
+> **startTime**: `number`
+
+开始时间的 Unix 秒级时间戳。
+
+##### title
+
+> **title**: `string`
+
+日历事件标题。
+
+<a id="addphonerepeatcalendarparams"></a>
+### AddPhoneRepeatCalendarParams
+
+添加重复日历事件的请求参数。
+
+#### Extends
+
+- [`AddPhoneCalendarParams`](#addphonecalendarparams)
+
+#### Properties
+
+##### alarm?
+
+> `optional` **alarm**: `boolean`
+
+是否提醒。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`alarm`](#alarm)
+
+##### alarmOffset?
+
+> `optional` **alarmOffset**: `number`
+
+提前提醒时间，单位秒。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`alarmOffset`](#alarmoffset)
+
+##### allDay?
+
+> `optional` **allDay**: `boolean`
+
+是否为全天事件。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`allDay`](#allday)
+
+##### description?
+
+> `optional` **description**: `string`
+
+事件描述。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`description`](#description)
+
+##### endTime?
+
+> `optional` **endTime**: `number`
+
+结束时间的 Unix 秒级时间戳。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`endTime`](#endtime)
+
+##### location?
+
+> `optional` **location**: `string`
+
+事件位置。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`location`](#location)
+
+##### repeatEndTime?
+
+> `optional` **repeatEndTime**: `number`
+
+重复结束时间的 Unix 秒级时间戳。
+
+##### repeatInterval?
+
+> `optional` **repeatInterval**: [`CalendarRepeatInterval`](#calendarrepeatinterval)
+
+重复周期。
+
+##### startTime
+
+> **startTime**: `number`
+
+开始时间的 Unix 秒级时间戳。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`startTime`](#starttime)
+
+##### title
+
+> **title**: `string`
+
+日历事件标题。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`title`](#title)
+
+<a id="calendarrepeatinterval"></a>
+### CalendarRepeatInterval
+
+> **CalendarRepeatInterval**: `"day"` \| `"week"` \| `"month"` \| `"year"`
+
+日历重复周期。
+
+<a id="getclipboarddataresult"></a>
+### GetClipboardDataResult
+
+剪贴板读取结果。
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+当前剪贴板内容。
+
+<a id="setclipboarddataparams"></a>
+### SetClipboardDataParams
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+需要设置的剪贴板内容
+
+<a id="choosecontactresult"></a>
+### ChooseContactResult
+
+选取联系人后的返回结果。
+
+#### Properties
+
+##### displayName
+
+> **displayName**: `string`
+
+联系人名称。
+
+##### phoneNumber
+
+> **phoneNumber**: `string`
+
+选中的手机号。
+
+##### phoneNumberList
+
+> **phoneNumberList**: `string`[]
+
+联系人所有手机号。
+
+<a id="addphonecontactparams"></a>
+### AddPhoneContactParams
+
+添加手机联系人的请求参数。
+
+#### Properties
+
+##### addressCity?
+
+> `optional` **addressCity**: `string`
+
+家庭地址城市。
+
+##### addressCountry?
+
+> `optional` **addressCountry**: `string`
+
+家庭地址国家。
+
+##### addressPostalCode?
+
+> `optional` **addressPostalCode**: `string`
+
+家庭地址邮编。
+
+##### addressState?
+
+> `optional` **addressState**: `string`
+
+家庭地址省份。
+
+##### addressStreet?
+
+> `optional` **addressStreet**: `string`
+
+家庭地址街道。
+
+##### email?
+
+> `optional` **email**: `string`
+
+电子邮件。
+
+##### firstName
+
+> **firstName**: `string`
+
+名字。
+
+##### homeAddressCity?
+
+> `optional` **homeAddressCity**: `string`
+
+家庭地址城市。
+
+##### homeAddressCountry?
+
+> `optional` **homeAddressCountry**: `string`
+
+家庭地址国家。
+
+##### homeAddressPostalCode?
+
+> `optional` **homeAddressPostalCode**: `string`
+
+家庭地址邮编。
+
+##### homeAddressState?
+
+> `optional` **homeAddressState**: `string`
+
+家庭地址省份。
+
+##### homeAddressStreet?
+
+> `optional` **homeAddressStreet**: `string`
+
+家庭地址街道。
+
+##### homeFaxNumber?
+
+> `optional` **homeFaxNumber**: `string`
+
+家庭传真。
+
+##### homePhoneNumber?
+
+> `optional` **homePhoneNumber**: `string`
+
+家庭电话。
+
+##### hostNumber?
+
+> `optional` **hostNumber**: `string`
+
+公司电话。
+
+##### lastName?
+
+> `optional` **lastName**: `string`
+
+姓。
+
+##### middleName?
+
+> `optional` **middleName**: `string`
+
+中间名。
+
+##### mobilePhoneNumber?
+
+> `optional` **mobilePhoneNumber**: `string`
+
+手机号。
+
+##### nickName?
+
+> `optional` **nickName**: `string`
+
+昵称。
+
+##### organization?
+
+> `optional` **organization**: `string`
+
+公司。
+
+##### photoFilePath?
+
+> `optional` **photoFilePath**: `string`
+
+头像文件路径。
+
+##### remark?
+
+> `optional` **remark**: `string`
+
+备注。
+
+##### title?
+
+> `optional` **title**: `string`
+
+职位。
+
+##### url?
+
+> `optional` **url**: `string`
+
+个人网站。
+
+##### weChatNumber?
+
+> `optional` **weChatNumber**: `string`
+
+微信号。
+
+##### workAddressCity?
+
+> `optional` **workAddressCity**: `string`
+
+工作地址城市。
+
+##### workAddressCountry?
+
+> `optional` **workAddressCountry**: `string`
+
+工作地址国家。
+
+##### workAddressPostalCode?
+
+> `optional` **workAddressPostalCode**: `string`
+
+工作地址邮编。
+
+##### workAddressState?
+
+> `optional` **workAddressState**: `string`
+
+工作地址省份。
+
+##### workAddressStreet?
+
+> `optional` **workAddressStreet**: `string`
+
+工作地址街道。
+
+##### workFaxNumber?
+
+> `optional` **workFaxNumber**: `string`
+
+工作传真。
+
+##### workPhoneNumber?
+
+> `optional` **workPhoneNumber**: `string`
+
+工作电话。
+
+<a id="getrandomvaluesparams"></a>
+### GetRandomValuesParams
+
+获取安全随机数的请求参数。
+
+#### Properties
+
+##### length
+
+> **length**: `number`
+
+需要生成的字节数。
+
+<a id="getrandomvaluesresult"></a>
+### GetRandomValuesResult
+
+获取安全随机数的返回结果。
+
+#### Properties
+
+##### randomValues
+
+> **randomValues**: `ArrayBuffer`
+
+生成的随机字节。
+
+<a id="makephonecallparams"></a>
+### MakePhoneCallParams
+
+#### Properties
+
+##### phoneNumber
+
+> **phoneNumber**: `string`
+
+需要拨打的电话号码
+
+<a id="scancodeparams"></a>
+### ScanCodeParams
+
+扫码请求参数。
+
+#### Properties
+
+##### onlyFromCamera?
+
+> `optional` **onlyFromCamera**: `boolean`
+
+是否仅允许从相机扫码。
+
+##### scanType?
+
+> `optional` **scanType**: [`ScanCodeType`](#scancodetype)[]
+
+允许的扫码类型。
+
+<a id="scancoderesult"></a>
+### ScanCodeResult
+
+扫码返回结果。
+
+#### Properties
+
+##### characterSet
+
+> **characterSet**: `string`
+
+字符集。
+
+##### path
+
+> **path**: `string`
+
+当前宿主可识别的页面路径。
+
+##### rawData
+
+> **rawData**: `string`
+
+原始数据，通常为 Base64 字符串。
+
+##### result
+
+> **result**: `string`
+
+扫码结果文本。
+
+##### scanType
+
+> **scanType**: [`ScanResultType`](#scanresulttype)
+
+扫码结果类型。
+
+<a id="scancodetype"></a>
+### ScanCodeType
+
+> **ScanCodeType**: `"barCode"` \| `"qrCode"` \| `"datamatrix"` \| `"pdf417"`
+
+扫码类型。
+
+<a id="scanresulttype"></a>
+### ScanResultType
+
+> **ScanResultType**: `"QR_CODE"` \| `"AZTEC"` \| `"CODABAR"` \| `"CODE_39"` \| `"CODE_93"` \| `"CODE_128"` \| `"DATA_MATRIX"` \| `"EAN_8"` \| `"EAN_13"` \| `"ITF"` \| `"MAXICODE"` \| `"PDF_417"` \| `"RSS_14"` \| `"RSS_EXPANDED"` \| `"UPC_A"` \| `"UPC_E"` \| `"UPC_EAN_EXTENSION"` \| `"WX_CODE"` \| `"CODE_25"`
+
+扫码结果类型。
+
+<a id="getscreenbrightnessresult"></a>
+### GetScreenBrightnessResult
+
+#### Properties
+
+##### value
+
+> **value**: `number`
+
+屏幕亮度值，范围 0 ~ 1，0 最暗，1 最亮
+
+<a id="setvisualeffectoncaptureparams"></a>
+### SetVisualEffectOnCaptureParams
+
+设置截屏或录屏视觉效果的请求参数。
+
+#### Properties
+
+##### visualEffect?
+
+> `optional` **visualEffect**: [`CaptureVisualEffect`](#capturevisualeffect)
+
+截屏或录屏时的视觉表现。
+
+<a id="capturevisualeffect"></a>
+### CaptureVisualEffect
+
+> **CaptureVisualEffect**: `"none"` \| `"hidden"`
+
+录屏或截屏时的视觉表现。
+
+<a id="setscreenbrightnessparams"></a>
+### SetScreenBrightnessParams
+
+设置屏幕亮度的请求参数。
+
+#### Properties
+
+##### value
+
+> **value**: `number`
+
+屏幕亮度值，范围 0 ~ 1。
+
+<a id="setkeepscreenonparams"></a>
+### SetKeepScreenOnParams
+
+设置屏幕常亮的请求参数。
+
+#### Properties
+
+##### keepScreenOn
+
+> **keepScreenOn**: `boolean`
+
+是否保持屏幕常亮。
+
+<a id="vibrateshortparams"></a>
+### VibrateShortParams
+
+短震动请求参数。
+
+#### Properties
+
+##### type?
+
+> `optional` **type**: [`VibrateShortType`](#vibrateshorttype)
+
+震动强度类型。
+
+<a id="vibrateshorttype"></a>
+### VibrateShortType
+
+> **VibrateShortType**: `"heavy"` \| `"medium"` \| `"light"`
+
+短震动类型。