設置數據項名稱

說明： 本模塊首批接口從API version 8開始支持。后續版本如有新增內容，則采用上角標單獨標記該內容的起始版本。

本模塊提供設置數據項的訪問功能相關接口的說明及示例。

導入模塊

import settings from '@ohos.settings';

settings.getUriSync

getUriSync(name: string): string

獲取數據項的URI。

系統能力：SystemCapability.Applictaions.settings.Core。

• 參數：

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

  • • 亮度：‘settings.screen.brightness’
    • 時間格式：‘settings.time.format’
  • 開發者自行添加的數據項。 |

• 返回值：

  類型	說明
  string	數據項的URI。

• 示例：

   // 獲取數據項的URIlet urivar = settings.getUriSync('settings.screen.brightness');  
  

settings.getValueSync

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

獲取數據項的值。

系統能力：SystemCapability.Applictaions.settings.Core。

• 參數：

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

  • • 亮度：‘settings.screen.brightness’
    • 時間格式：‘settings.time.format’
  • 開發者自行添加的數據項。 |
    | defValue | string | 是 | 默認值。由開發者設置，當未從數據庫中查詢到該數據時，則返回該默認值。 |

• 返回值：

  類型	說明
  string	返回數據項的值。

• 示例：

  import featureAbility from '@ohos.featureAbility';//獲取數據項亮度的值（該數據項在數據庫中已存在）
  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

設置數據項的值。 如果數據庫中已經存在該數據項，則setValueSync方法將更新該數據項的值；如果數據庫中尚未存在該數據項，則setValueSync方法將向數據庫中插入該數據項。

需要權限：ohos.permission.WRITE_SYSTEM_SETTING。

系統能力：SystemCapability.Applictaions.settings.Core。

• 參數：

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

  • • 亮度：‘settings.screen.brightness’
    • 時間格式：‘settings.time.format’
  • 開發者自行添加的數據項。 |
    | value | string | 是 | 數據項的具體數值。 |

• 返回值：

  類型	說明
  boolean	返回設置數據項的值是否成功的結果。true表示設置成功，false則表示設置失敗。

• 示例：

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