設(shè)置數(shù)據(jù)項(xiàng)名稱

說明： 本模塊首批接口從API version 8開始支持。后續(xù)版本如有新增內(nèi)容，則采用上角標(biāo)單獨(dú)標(biāo)記該內(nèi)容的起始版本。 開發(fā)前請(qǐng)熟悉鴻蒙開發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

本模塊提供設(shè)置數(shù)據(jù)項(xiàng)的訪問功能相關(guān)接口的說明及示例。

導(dǎo)入模塊

import settings from '@ohos.settings';

settings.getUriSync

getUriSync(name: string): string

獲取數(shù)據(jù)項(xiàng)的URI。

系統(tǒng)能力 ：SystemCapability.Applictaions.settings.Core。

• 參數(shù)：

  參數(shù)名	類型	必填	說明
  name	string	是	數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種： - 數(shù)據(jù)庫中已存在的數(shù)據(jù)項(xiàng)，包括：

  • • 亮度：'settings.screen.brightness'
      • 時(shí)間格式：'settings.time.format'
  • 開發(fā)者自行添加的數(shù)據(jù)項(xiàng)。 |

• 返回值：

  類型	說明
  string	數(shù)據(jù)項(xiàng)的URI。

• 示例：

  // 獲取數(shù)據(jù)項(xiàng)的URI
   let urivar = settings.getUriSync('settings.screen.brightness');
  

settings.getValueSync

getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string

獲取數(shù)據(jù)項(xiàng)的值。

系統(tǒng)能力 ：SystemCapability.Applictaions.settings.Core。

• 參數(shù)：

  參數(shù)名	類型	必填	說明
  dataAbilityHelper	[DataAbilityHelper]	是	數(shù)據(jù)管理輔助類。
  name	string	是	數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種： - 數(shù)據(jù)庫中已存在的數(shù)據(jù)項(xiàng)，包括：

  • • 亮度：'settings.screen.brightness'
      • 時(shí)間格式：'settings.time.format'
  • 開發(fā)者自行添加的數(shù)據(jù)項(xiàng)。 |
    | defValue | string | 是 | 默認(rèn)值。由開發(fā)者設(shè)置，當(dāng)未從數(shù)據(jù)庫中查詢到該數(shù)據(jù)時(shí)，則返回該默認(rèn)值。 |

• 返回值：

  類型	說明
  string	返回?cái)?shù)據(jù)項(xiàng)的值。

• 示例：

  import featureAbility from '@ohos.featureAbility';
  
  //獲取數(shù)據(jù)項(xiàng)亮度的值（該數(shù)據(jù)項(xiàng)在數(shù)據(jù)庫中已存在）
  let brightness = 'settings.screen.brightness';
  let uri = settings.getUriSync(brightness);
  let helper = featureAbility.acquireDataAbilityHelper(uri);
  let value = settings.getValueSync(helper, brightness, '10');
  

settings.setValueSync

setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean

設(shè)置數(shù)據(jù)項(xiàng)的值。 如果數(shù)據(jù)庫中已經(jīng)存在該數(shù)據(jù)項(xiàng)，則setValueSync方法將更新該數(shù)據(jù)項(xiàng)的值；如果數(shù)據(jù)庫中尚未存在該數(shù)據(jù)項(xiàng)，則setValueSync方法將向數(shù)據(jù)庫中插入該數(shù)據(jù)項(xiàng)。

需要權(quán)限 ：ohos.permission.WRITE_SYSTEM_SETTING。

系統(tǒng)能力 ：SystemCapability.Applictaions.settings.Core。

• 參數(shù)：

  參數(shù)名	類型	必填	說明
  dataAbilityHelper	[DataAbilityHelper]	是	數(shù)據(jù)管理輔助類。
  name	string	是	數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種： - 數(shù)據(jù)庫中已存在的數(shù)據(jù)項(xiàng)，包括：

  • • 亮度：'settings.screen.brightness'
      • 時(shí)間格式：'settings.time.format'
  • 開發(fā)者自行添加的數(shù)據(jù)項(xiàng)。 |
    | value | string | 是 | 數(shù)據(jù)項(xiàng)的具體數(shù)值。 |

• 返回值：
  

  類型	說明HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿
  boolean	返回設(shè)置數(shù)據(jù)項(xiàng)的值是否成功的結(jié)果。true表示設(shè)置成功，false則表示設(shè)置失敗。

• 示例：

  import featureAbility from '@ohos.featureAbility';
  
  //更新數(shù)據(jù)項(xiàng)亮度的值（該數(shù)據(jù)項(xiàng)在數(shù)據(jù)庫中已存在，故setValueSync方法將更新該數(shù)據(jù)項(xiàng)的值）
  let brightness = 'settings.screen.brightness';
  let uri = settings.getUriSync(brightness);
  let helper = featureAbility.acquireDataAbilityHelper(uri);
  let ret = settings.setValueSync(helper, brightness, '100');
  

審核編輯 黃宇