Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 62767aa2 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!12272 修改接口文档 

Merge pull request !12272 from liminjie10/master
上级 84815acf 84ce10c6
显示空白变更内容
内联 并排
Showing with 335 addition and 118 deletion
zh-cn/application-dev/reference/apis/js-apis-settings.md
浏览文件 @ 62767aa2
...@@ -35,6 +35,8 @@ import settings from '@ohos.settings'; ...@@ -35,6 +35,8 @@ import settings from '@ohos.settings';
**系统能力：** SystemCapability.Applications.settings.Core **系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | | ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| FONT_SCALE | string | 是 | 是 | 字体的比例因子，值为浮点数。 | | FONT_SCALE | string | 是 | 是 | 字体的比例因子，值为浮点数。 |
...@@ -185,9 +187,112 @@ import settings from '@ohos.settings'; ...@@ -185,9 +187,112 @@ import settings from '@ohos.settings';
| WIFI_STATUS | string | 是 | 是 | Wi-Fi是否可用。<br>值为true表示Wi-Fi可用；<br/>值为false表示Wi-Fi不可用。 | | WIFI_STATUS | string | 是 | 是 | Wi-Fi是否可用。<br>值为true表示Wi-Fi可用；<br/>值为false表示Wi-Fi不可用。 |
| WIFI_WATCHDOG_STATUS | string | 是 | 是 | Wi-Fi的WatchDog是否可用。 <br>值为true表示可用；<br/>值为false表示不可用。 | | WIFI_WATCHDOG_STATUS | string | 是 | 是 | Wi-Fi的WatchDog是否可用。 <br>值为true表示可用；<br/>值为false表示不可用。 |
## settings.enableAirplaneMode
enableAirplaneMode(enable: boolean, callback: AsyncCallback\<void>): void
启用或禁用飞行模式。使用callback异步回调。
**系统能力**：SystemCapability.Applications.settings.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ----------------------------------------------- |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。 |
**示例**：
```js
let isEnabled = true;
settings.enableAirplaneMode(isEnabled, (err) => {
if (err) {
console.log('Failed to enable AirplaneMode.');
return;
}
console.log('Return true if enable.');
})
```
## settings.enableAirplaneMode
enableAirplaneMode(enable: boolean): Promise\<void>
启用或禁用飞行模式。使用Promise异步回调。
**系统能力**：SystemCapability.Applications.settings.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ----------------------------------------------- |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 |
**返回值**：
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 无返回结果的Promise对象。 |
**示例**：
```js
let isEnabled = true;
settings.enableAirplaneMode(isEnabled).then(() => {
console.log('Succeeded in enabling AirplaneMode.');
}).catch((err) => {
console.log(`Failed to enable AirplaneMode. Cause: ${err}`);
})
```
## settings.canShowFloating
canShowFloating(callback: AsyncCallback\<boolean>): void
检查应用是否能够以悬浮窗形式显示。使用callback异步回调。
**系统能力**：SystemCapability.Applications.settings.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 |
**示例**：
```js
settings.canShowFloating((result) => {
console.log('Checks whether a specified application can show as float window.');
});
```
## settings.canShowFloating
canShowFloating(): Promise\<boolean>
检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。
**系统能力**：SystemCapability.Applications.settings.Core
**返回值**：
| 类型 | 说明 |
| ----------------- | ------------------------------------------------------------ |
| Promise\<boolean> | Promise对象。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 |
**示例**：
```js
settings.canShowFloating().then((result) => {
console.log('Checks whether a specified application can show as float window.');
});
```
## setting.getURI ## setting.getURI
getURI(name: string, callback: AsyncCallback\<object>): void getURI(name: string, callback: AsyncCallback\<string>): void
获取数据项的URI。使用callback异步回调。 获取数据项的URI。使用callback异步回调。
...@@ -198,7 +303,7 @@ getURI(name: string, callback: AsyncCallback\<object>): void ...@@ -198,7 +303,7 @@ getURI(name: string, callback: AsyncCallback\<object>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| callback | AsyncCallback\<object> | 是 | 回调函数。获取数据项的URI。 | | callback | AsyncCallback\<string> | 是 | 回调函数。获取数据项的URI。 |
**示例**： **示例**：
...@@ -210,7 +315,7 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri) => { ...@@ -210,7 +315,7 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri) => {
## setting.getURI ## setting.getURI
getURI(name: string): Promise\<object> getURI(name: string): Promise\<string>
获取数据项的URI。使用Promise异步回调。 获取数据项的URI。使用Promise异步回调。
...@@ -226,7 +331,7 @@ getURI(name: string): Promise\<object> ...@@ -226,7 +331,7 @@ getURI(name: string): Promise\<object>
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------------ | | ---------------- | ------------------------------------ |
| Promise\<object> | Promise对象。返回获取的数据项的URI。 | | Promise\<string> | Promise对象。返回获取的数据项的URI。 |
**示例**： **示例**：
...@@ -236,30 +341,55 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri) => { ...@@ -236,30 +341,55 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri) => {
}) })
``` ```
## setting.getValue ## settings.getUriSync<sup>8+</sup>
getUriSync(name: string): string
获取数据项的URI。
**系统能力**：SystemCapability.Applications.settings.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
**返回值**：
| 类型 | 说明 |
| ------ | ------------- |
| string | 数据项的URI。 |
**示例**：
```js
// 获取数据项的URI
let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
```
## setting.getValue<sup>9+</sup>
getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\<object>): void getValue(context: Context, name: string, callback: AsyncCallback\<string>): void
获取数据库中指定数据项的值。使用callback异步回调。 获取数据库中指定数据项的值。使用callback异步回调。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在Stage模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | context | Context | 是 | 上下文内容。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| callback | AsyncCallback\<object> | 是 | 使用callback方式获取数据项的值。 | | callback | AsyncCallback\<string> | 是 | 使用callback方式获取数据项的值。 |
**示例**： **示例**：
```js ```js
import featureAbility from '@ohos.ability.featureAbility'; settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => {
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri);
settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => {
if (err) { if (err) {
console.error(`Failed to get the setting. ${err.message} `); console.error(`Failed to get the setting. ${err.message} `);
return; return;
...@@ -268,88 +398,117 @@ settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value ...@@ -268,88 +398,117 @@ settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value
}); });
``` ```
## setting.getValue ## setting.getValue<sup>9+</sup>
getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\<object> getValue(context: Context, name: string): Promise\<string>
获取数据库中指定数据项的值。使用Promise异步回调。 获取数据库中指定数据项的值。使用Promise异步回调。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在Stage模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | context | Context | 是 | 上下文内容。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
**返回值**： **返回值**：
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------------------- | | ---------------- | ----------------------------------- |
| Promise\<object> | Promise对象。返回获得的数据项的值。 | | Promise\<string> | Promise对象。返回获得的数据项的值。 |
**示例**： **示例**：
```js ```js
import featureAbility from '@ohos.ability.featureAbility'; settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS)
.then((value) => {
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri);
settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => {
console.log(`promise:value -> ${JSON.stringify(value)}`) console.log(`promise:value -> ${JSON.stringify(value)}`)
}); });
``` ```
## settings.setValue ## settings.getValueSync<sup>9+</sup>
getValueSync(context: Context, name: string, defValue: string): string
获取数据项的值。此方法相较getValue为同步方法。
**系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在Stage模型下使用。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 上下文内容。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 |
**返回值**：
| 类型 | 说明 |
| ------ | ---------------- |
| string | 返回数据项的值。 |
**示例**：
```js
//获取数据项亮度的值（该数据项在数据库中已存在）
let value = settings.getValueSync(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '10');
```
## settings.setValue<sup>9+</sup>
setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, callback: AsyncCallback\<boolean>): void setValue(context: Context, name: string, value: string, callback: AsyncCallback\<boolean>): void
将数据项名称及数据项的值保存到数据库中。使用callback异步回调。 将数据项名称及数据项的值保存到数据库中。使用callback异步回调。
**系统接口**：此接口为系统接口。 **需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在Stage模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | context | Context | 是 | 上下文内容。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | object | 是 | 数据项值。取值范围随业务变动。 | | value | string | 是 | 数据项值。取值范围随业务变动。 |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败。 | | callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败。 |
**示例**： **示例**：
```js ```js
import featureAbility from '@ohos.ability.featureAbility'; settings.setValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (result) => {
//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri);
settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (status) => {
console.log('Callback return whether value is set.'); console.log('Callback return whether value is set.');
}); });
``` ```
## settings.setValue ## settings.setValue<sup>9+</sup>
setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Promise\<boolean> setValue(context: Context, name: string, value: string): Promise\<boolean>
将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。 将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。
**系统接口**：此接口为系统接口。 **需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在Stage模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | context | Context | 是 | 上下文内容。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | object | 是 | 数据项值。取值范围随业务变动。 | | value | string | 是 | 数据项值。取值范围随业务变动。 |
**返回值**： **返回值**：
...@@ -360,147 +519,199 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Pro ...@@ -360,147 +519,199 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Pro
**示例**： **示例**：
```js ```js
import featureAbility from '@ohos.ability.featureAbility'; settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((result) => {
//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri);
settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((status) => {
console.log('Callback return whether value is set.'); console.log('Callback return whether value is set.');
}); });
``` ```
## settings.enableAirplaneMode ## settings.setValueSync<sup>9+</sup>
enableAirplaneMode(enable: boolean, callback: AsyncCallback\<void>): void setValueSync(context: Context, name: string, value: string): boolean
启用或禁用飞行模式。使用callback异步回调。 设置数据项的值。此方法相较setValue为同步方法。
如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在Stage模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ----------------------------------------------- | | ------- | ------- | ---- | ------------------------------------------------------------ |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | | context | Context | 是 | 上下文内容。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 |
**返回值**：
| 类型 | 说明 |
| ------- | ------------------------------------------------------------ |
| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false表示设置失败。 |
**示例**： **示例**：
```js ```js
let isEnabled = true; //更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值）
settings.enableAirplaneMode(isEnabled, (err) => { let ret = settings.setValueSync(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100');
if (err) {
console.log('Failed to enable AirplaneMode.');
return;
}
console.log('Return true if enable.');
})
``` ```
## settings.enableAirplaneMode ## setting.getValue<sup>(deprecated)</sup>
enableAirplaneMode(enable: boolean): Promise\<void> > 从API version 7开始支持，从API version 9开始废弃，推荐使用[getValue()](#settinggetvalue9)。
启用或禁用飞行模式。使用Promise异步回调。 getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\<string>): void
获取数据库中指定数据项的值。使用callback异步回调。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在FA模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ----------------------------------------------- | | ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | | dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
**返回值**： | callback | AsyncCallback\<string> | 是 | 使用callback方式获取数据项的值。 |
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 无返回结果的Promise对象。 |
**示例**： **示例**：
```js ```js
let isEnabled = true; import featureAbility from '@ohos.ability.featureAbility';
settings.enableAirplaneMode(isEnabled).then(() => {
console.log('Succeeded in enabling AirplaneMode.'); let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
}).catch((err) => { let helper = featureAbility.acquireDataAbilityHelper(uri);
console.log(`Failed to enable AirplaneMode. Cause: ${err}`); settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => {
}) if (err) {
console.error(`Failed to get the setting. ${err.message} `);
return;
}
console.log(`callback:value -> ${JSON.stringify(value)}`)
});
``` ```
## settings.canShowFloating ## setting.getValue<sup>(deprecated)</sup>
canShowFloating(callback: AsyncCallback\<boolean>): void > 从API version 7开始支持，从API version 9开始废弃，推荐使用[getValue()](#settinggetvalue9-1)。
检查应用是否能够以悬浮窗形式显示。使用callback异步回调。 getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\<string>
获取数据库中指定数据项的值。使用Promise异步回调。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在FA模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | | dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
**返回值**：
| 类型 | 说明 |
| ---------------- | ----------------------------------- |
| Promise\<string> | Promise对象。返回获得的数据项的值。 |
**示例**： **示例**：
```js ```js
settings.canShowFloating((status) => { import featureAbility from '@ohos.ability.featureAbility';
console.log('Checks whether a specified application can show as float window.');
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri);
settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => {
console.log(`promise:value -> ${JSON.stringify(value)}`)
}); });
``` ```
## settings.canShowFloating ## settings.setValue<sup>(deprecated)</sup>
canShowFloating(): Promise\<boolean> > 从API version 7开始支持，从API version 9开始废弃，推荐使用[setValue()](#settingssetvalue9)。
检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。 setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string, callback: AsyncCallback\<boolean>): void
将数据项名称及数据项的值保存到数据库中。使用callback异步回调。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**返回值**： **模型约束**：此接口仅可在FA模型下使用。
| 类型 | 说明 | **参数**：
| ----------------- | ------------------------------------------------------------ |
| Promise\<boolean> | Promise对象。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | string | 是 | 数据项值。取值范围随业务变动。 |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败。 |
**示例**： **示例**：
```js ```js
settings.canShowFloating().then((status) => { import featureAbility from '@ohos.ability.featureAbility';
console.log('Checks whether a specified application can show as float window.');
//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri);
settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (result) => {
console.log('Callback return whether value is set.');
}); });
``` ```
## settings.getUriSync<sup>8+</sup> ## settings.setValue<sup>(deprecated)</sup>
getUriSync(name: string): string > 从API version 7开始支持，从API version 9开始废弃，推荐使用[setValue()](#settingssetvalue9-1)。
获取数据项的URI。 setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string): Promise\<boolean>
将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在FA模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | string | 是 | 数据项值。取值范围随业务变动。 |
**返回值**： **返回值**：
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------- | | ----------------- | -------------------------------------------------- |
| string | 数据项的URI。 | | Promise\<boolean> | Promise对象。返回true表示操作成功，否则返回false。 |
**示例**： **示例**：
```js ```js
// 获取数据项的URI import featureAbility from '@ohos.ability.featureAbility';
let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri);
settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((result) => {
console.log('Callback return whether value is set.');
});
``` ```
## settings.getValueSync<sup>8+</sup> ## settings.getValueSync<sup>(deprecated)</sup>
> 从API version 8开始支持，从API version 9开始废弃，推荐使用[getValueSync()](#settingsgetvaluesync9)。
getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string
...@@ -508,6 +719,8 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin ...@@ -508,6 +719,8 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在FA模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -533,7 +746,9 @@ let helper = featureAbility.acquireDataAbilityHelper(uri); ...@@ -533,7 +746,9 @@ let helper = featureAbility.acquireDataAbilityHelper(uri);
let value = settings.getValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); let value = settings.getValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '10');
``` ```
## settings.setValueSync<sup>8+</sup> ## settings.setValueSync<sup>(deprecated)</sup>
> 从API version 8开始支持，从API version 9开始废弃，推荐使用[setValueSync()](#settingssetvaluesync9)。
setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean
...@@ -541,10 +756,12 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): ...@@ -541,10 +756,12 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string):
如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。
**需要权限**：ohos.permission.MANAGE_SECUER_SETTINGS，仅系统应用可用。 **需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**模型约束**：此接口仅可在FA模型下使用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或