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

2024-01-23 17:47 更新

本模塊提供訪問(wèn)設(shè)置數(shù)據(jù)項(xiàng)的能力。

說(shuō)明

本模塊首批接口從API version 7開(kāi)始支持。后續(xù)版本如有新增內(nèi)容，則采用上角標(biāo)單獨(dú)標(biāo)記該內(nèi)容的起始版本。

導(dǎo)入模塊

  1. import settings from '@ohos.settings';

date

提供設(shè)置時(shí)間和日期格式的數(shù)據(jù)項(xiàng)。

屬性

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

名稱

類型

可讀

可寫(xiě)

說(shuō)明

DATE_FORMAT

string

是

是

日期格式。

日期格式包括mm/dd/yyyy、dd/mm/yyyy和yyyy/mm/dd ，其中mm、dd和yyyy分別代表月份、日期和年份。

TIME_FORMAT

string

是

是

時(shí)間是以12小時(shí)格式還是24小時(shí)格式顯示。

值為 “12” 表示12小時(shí)格式；

值為 ”24“ 表示24小時(shí)格式。

AUTO_GAIN_TIME

string

是

是

是否自動(dòng)從網(wǎng)絡(luò)獲取日期、時(shí)間和時(shí)區(qū)。

值為true表示自動(dòng)從網(wǎng)絡(luò)獲取信息；

值為false表示不自動(dòng)獲取。

AUTO_GAIN_TIME_ZONE

string

是

是

是否自動(dòng)從NITZ獲取時(shí)區(qū)。

值為true表示自動(dòng)獲??；

值為false表示不自動(dòng)獲取。

display

提供設(shè)置顯示效果的數(shù)據(jù)項(xiàng)。

屬性

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

名稱

類型

可讀

可寫(xiě)

說(shuō)明

FONT_SCALE

string

是

是

字體的比例因子，值為浮點(diǎn)數(shù)。

SCREEN_BRIGHTNESS_STATUS

string

是

是

屏幕亮度。該值的范圍從0到255。

AUTO_SCREEN_BRIGHTNESS

string

是

是

是否啟用屏幕亮度自動(dòng)調(diào)整。

值為AUTO_SCREEN_BRIGHTNESS_MODE，表示啟用自動(dòng)調(diào)整；

值為MANUAL_SCREEN_BRIGHTNESS_MODE，表示不啟用自動(dòng)調(diào)整。

AUTO_SCREEN_BRIGHTNESS_MODE

number

是

是

使用屏幕亮度自動(dòng)調(diào)整時(shí)AUTO_SCREEN_BRIGHTNESS的值。

MANUAL_SCREEN_BRIGHTNESS_MODE

number

是

是

使用屏幕亮度手動(dòng)調(diào)整時(shí)的AUTO_SCREEN_BRIGHTNESS值。

SCREEN_OFF_TIMEOUT

string

是

是

設(shè)備在一段時(shí)間不活動(dòng)后進(jìn)入睡眠狀態(tài)的等待時(shí)間（單位：ms）。

DEFAULT_SCREEN_ROTATION

string

是

是

啟用屏幕的自動(dòng)旋轉(zhuǎn)時(shí)，此屬性無(wú)效；不啟用自動(dòng)旋轉(zhuǎn)時(shí)，以下值可用：

值為0，表示屏幕旋轉(zhuǎn)0度；

值為1，表示屏幕旋轉(zhuǎn)90度；

值為2，表示屏幕旋轉(zhuǎn)180度；

值為3，表示屏幕旋轉(zhuǎn)270度。

ANIMATOR_DURATION_SCALE

string

是

是

動(dòng)畫(huà)持續(xù)時(shí)間的比例因子。這會(huì)影響所有此類動(dòng)畫(huà)的開(kāi)始延遲和持續(xù)時(shí)間。

值為0，表示動(dòng)畫(huà)將立即結(jié)束，默認(rèn)值為1。

TRANSITION_ANIMATION_SCALE

string

是

是

過(guò)渡動(dòng)畫(huà)的比例因子。

值為0，表示禁用過(guò)渡動(dòng)畫(huà)。

WINDOW_ANIMATION_SCALE

string

是

是

普通窗口動(dòng)畫(huà)的比例因子。

值為0，表示禁用窗口動(dòng)畫(huà)。

DISPLAY_INVERSION_STATUS

string

是

是

是否啟用顯示顏色反轉(zhuǎn)。

值為1，表示啟用顯示顏色反轉(zhuǎn)；

值為0，表示不啟用顯示顏色反轉(zhuǎn)。

general

提供設(shè)置設(shè)備常規(guī)信息的數(shù)據(jù)項(xiàng)。

屬性

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

名稱

類型

可讀

可寫(xiě)

說(shuō)明

SETUP_WIZARD_FINISHED

string

是

是

是否已運(yùn)行啟動(dòng)向?qū)А?/p>

值為0，表示啟動(dòng)向?qū)形催\(yùn)行；

值不是0，表示啟動(dòng)向?qū)б堰\(yùn)行。

END_BUTTON_ACTION

string

是

是

在用戶不在呼叫中時(shí)，用戶按下呼叫結(jié)束按鈕會(huì)發(fā)生的情況。

值為0，表示沒(méi)有任何反應(yīng)；

值為1，表示顯示主屏幕；

值為2，表示設(shè)備進(jìn)入睡眠狀態(tài)，屏幕鎖定；

值為3，表示顯示主屏幕。如果用戶已在主屏幕上，設(shè)備將進(jìn)入睡眠狀態(tài)。

ACCELEROMETER_ROTATION_STATUS

string

是

是

是否使用加速計(jì)更改屏幕方向，即是否啟用自動(dòng)旋轉(zhuǎn)。

值為1，表示啟用加速度計(jì)；

值為0，表示不啟用加速計(jì)。

AIRPLANE_MODE_STATUS

string

是

是

是否啟用飛行模式。

值為1，表示啟用飛行模式；

值為0，表示不啟用飛行模式。

DEVICE_PROVISION_STATUS

string

是

是

是否預(yù)配設(shè)備。

在具有單個(gè)系統(tǒng)用戶的多用戶設(shè)備上，當(dāng)值為true時(shí)，屏幕可能會(huì)被鎖定。此外，其他功能無(wú)法在系統(tǒng)用戶上啟動(dòng)，除非它們被標(biāo)記為在屏幕鎖定上顯示。

HDC_STATUS

string

是

是

是否啟用USB設(shè)備上的硬盤(pán)控制器（HDC）。

值為true，表示啟用HDC；

值為false，表示不啟用HDC。

BOOT_COUNTING

string

是

是

設(shè)備開(kāi)機(jī)后的啟動(dòng)操作數(shù)。

CONTACT_METADATA_SYNC_STATUS

string

是

是

是否啟用聯(lián)系人元數(shù)據(jù)同步。

值為true，表示啟用同步；

值為false，表示不啟用同步。

DEVELOPMENT_SETTINGS_STATUS

string

是

是

是否啟用開(kāi)發(fā)人員選項(xiàng)。

值為true，表示啟用開(kāi)發(fā)人員選項(xiàng)；

值為false，表示不啟用開(kāi)發(fā)人員選項(xiàng)。

DEVICE_NAME

string

是

是

設(shè)備名稱。

USB_STORAGE_STATUS

string

是

是

是否啟用USB大容量存儲(chǔ)。

值為true，表示啟用USB大容量存儲(chǔ)；

值為false，表示不啟用USB大容量存儲(chǔ)。

DEBUGGER_WAITING

string

是

是

設(shè)備在啟動(dòng)應(yīng)用程序進(jìn)行調(diào)試時(shí)是否等待調(diào)試器進(jìn)行調(diào)試。

值為1，表示設(shè)備等待調(diào)試器；

值為0，表示系統(tǒng)不會(huì)等待調(diào)試器，因此應(yīng)用程序會(huì)正常運(yùn)行。

DEBUG_APP_PACKAGE

string

是

是

要調(diào)試的應(yīng)用程序的bundle name。

ACCESSIBILITY_STATUS

string

是

是

是否啟用輔助功能。

值為1，表示啟用輔助功能；

值為0，表示不啟用輔助功能。

ACTIVATED_ACCESSIBILITY_SERVICES

string

是

是

已激活的輔助功能的列表。

GEOLOCATION_ORIGINS_ALLOWED

string

是

是

瀏覽器可以使用的默認(rèn)地理位置。多個(gè)地理位置由空格分隔。

SKIP_USE_HINTS

string

是

是

應(yīng)用程序是否應(yīng)在首次啟動(dòng)時(shí)嘗試跳過(guò)所有介紹性提示。這適用于臨時(shí)用戶或熟悉環(huán)境的用戶。

值為1，表示應(yīng)用程序?qū)L試在第一次啟動(dòng)時(shí)跳過(guò)所有介紹性提示；

值為0，表示應(yīng)用程序不會(huì)在首次啟動(dòng)時(shí)跳過(guò)介紹性提示。

TOUCH_EXPLORATION_STATUS

string

是

是

是否啟用觸摸瀏覽。

值為1，表示啟用觸摸瀏覽；

值為0，表示不啟用觸摸瀏覽。

input

提供設(shè)置有關(guān)輸入法信息的數(shù)據(jù)項(xiàng)。

屬性

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

名稱

類型

可讀

可寫(xiě)

說(shuō)明

DEFAULT_INPUT_METHOD

string

是

是

默認(rèn)輸入法及其ID。

ACTIVATED_INPUT_METHOD_SUB_MODE

string

是

是

默認(rèn)輸入法鍵盤(pán)類型及其ID。

ACTIVATED_INPUT_METHODS

string

是

是

已激活的輸入法的列表。

該列表是一個(gè)字符串，由已激活的輸入法的ID和輸入法鍵盤(pán)類型組成。輸入法ID后添加冒號(hào)':'連接，輸入法的鍵盤(pán)類型后添加分號(hào)';'連接。用ima代表輸入法ID，keyboardType代表鍵盤(pán)類型，示例格式是ima0:keyboardType0;keyboardType1;ima1:ima2:keyboardTypes0。

SELECTOR_VISIBILITY_FOR_INPUT_METHOD

string

是

是

輸入法選擇器是否可見(jiàn)。

值為1，表示輸入法選擇器可見(jiàn)；

值為0，表示輸入法選擇器不可見(jiàn)。

AUTO_CAPS_TEXT_INPUT

string

是

是

是否為文本編輯器啟用自動(dòng)大寫(xiě)。

值為0，表示不啟用自動(dòng)大寫(xiě)；

值為1，表示啟用自動(dòng)大寫(xiě)。

AUTO_PUNCTUATE_TEXT_INPUT

string

是

是

是否為文本編輯器啟用自動(dòng)標(biāo)點(diǎn)符號(hào)。自動(dòng)標(biāo)點(diǎn)符號(hào)使文本編輯器能夠?qū)蓚€(gè)空格轉(zhuǎn)換為句點(diǎn)'.'和空格。

值為0，表示不啟用自動(dòng)標(biāo)點(diǎn)符號(hào)；

值為1，表示啟用自動(dòng)標(biāo)點(diǎn)符號(hào)。

AUTO_REPLACE_TEXT_INPUT

string

是

是

是否為文本編輯器啟用自動(dòng)更正。自動(dòng)更正使文本編輯器能夠更正拼寫(xiě)錯(cuò)誤。

值為0，表示不啟用自動(dòng)更正；

值為1，表示啟用自動(dòng)更正。

SHOW_PASSWORD_TEXT_INPUT

string

是

是

是否在文本編輯器中啟用密碼顯示。密碼顯示使文本編輯器能夠在用戶鍵入密碼字符時(shí)顯示密碼字符。

值為0，表示不啟用密碼顯示；

值為1，表示啟用密碼顯示。

network

提供設(shè)置網(wǎng)絡(luò)信息的數(shù)據(jù)項(xiàng)。

屬性

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

名稱

類型

可讀

可寫(xiě)

說(shuō)明

DATA_ROAMING_STATUS

string

是

是

是否啟用數(shù)據(jù)漫游。

值為true，表示啟用數(shù)據(jù)漫游；

值為false，表示不啟用數(shù)據(jù)漫游。

HTTP_PROXY_CFG

string

是

是

全局 HTTP 代理的主機(jī)名和端口號(hào)。主機(jī)名和端口號(hào)由冒號(hào)':'分隔。

NETWORK_PREFERENCE_USAGE

string

是

是

要使用的網(wǎng)絡(luò)的用戶首選項(xiàng)。

phone

提供設(shè)置來(lái)電和去電接聽(tīng)方式的數(shù)據(jù)項(xiàng)。

屬性

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

名稱

類型

可讀

可寫(xiě)

說(shuō)明

RTT_CALLING_STATUS

string

是

是

是否啟用實(shí)時(shí)文本 (RTT) 呼叫。啟用，來(lái)電和去電在設(shè)備和運(yùn)營(yíng)商支持時(shí)作為 RTT 呼叫應(yīng)答。

值為1，表示啟用RTT 呼叫；

值為0，表示不啟用 RTT 呼叫。

sound

提供設(shè)置聲音效果的數(shù)據(jù)項(xiàng)。

屬性

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

名稱

類型

可讀

可寫(xiě)

說(shuō)明

VIBRATE_WHILE_RINGING

string

是

是

設(shè)備在來(lái)電響鈴時(shí)是否振動(dòng)。此屬性將由電話和設(shè)置應(yīng)用程序使用。 該值是布爾類型，僅影響設(shè)備因來(lái)電而響鈴的情況，不影響任何其他應(yīng)用程序或場(chǎng)景。

DEFAULT_ALARM_ALERT

string

是

是

系統(tǒng)默認(rèn)告警的存儲(chǔ)區(qū)域。

DTMF_TONE_TYPE_WHILE_DIALING

string

是

是

撥號(hào)時(shí)播放的雙音多頻 (DTMF) 音的類型。

值為0表示常規(guī)的短音效，

值為1表示長(zhǎng)音效。

DTMF_TONE_WHILE_DIALING

string

是

是

撥號(hào)時(shí)是否播放 DTMF 音。

值為1，表示播放 DTMF 音；

值為0，表示不播放。

AFFECTED_MODE_RINGER_STREAMS

string

是

是

哪些音頻流受振鈴模式和請(qǐng)勿打擾 (DND) 模式更改的影響。希望特定的音頻流受到振鈴模式和 DDN 模式變化的影響，請(qǐng)將對(duì)應(yīng)比特位設(shè)置為1。

AFFECTED_MUTE_STREAMS

string

是

是

受靜音模式影響的音頻流。希望特定音頻流在靜音模式下保持靜音，請(qǐng)將相應(yīng)位設(shè)置為1。

DEFAULT_NOTIFICATION_SOUND

string

是

是

系統(tǒng)默認(rèn)通知音的存儲(chǔ)區(qū)域。

DEFAULT_RINGTONE

string

是

是

系統(tǒng)默認(rèn)鈴聲的存儲(chǔ)區(qū)域。

SOUND_EFFECTS_STATUS

string

是

是

聲音功能是否可用。

值為0表示不可用；

值為1表示可用

VIBRATE_STATUS

string

是

是

設(shè)備是否為事件振動(dòng)。該參數(shù)在系統(tǒng)內(nèi)部使用。

值為1，表示設(shè)備會(huì)因事件而振動(dòng)；

值為0，表示設(shè)備不因事件振動(dòng)。

HAPTIC_FEEDBACK_STATUS

string

是

是

設(shè)備是否啟用觸覺(jué)反饋。

值為true，表示啟用觸覺(jué)反饋；

值為false，表示不啟用觸覺(jué)反饋。

TTS

提供設(shè)置文本到語(yǔ)音 (TTS) 轉(zhuǎn)換信息的數(shù)據(jù)項(xiàng)。

屬性

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

名稱

類型

可讀

可寫(xiě)

說(shuō)明

DEFAULT_TTS_PITCH

string

是

是

文本轉(zhuǎn)語(yǔ)音 (TTS) 引擎的默認(rèn)音高。

其中100=1x，該值設(shè)置為200，表示頻率是正常聲音頻率的兩倍。

DEFAULT_TTS_RATE

string

是

是

TTS 引擎的默認(rèn)語(yǔ)速。

其中100=1x。

DEFAULT_TTS_SYNTH

string

是

是

默認(rèn)TTS引擎。

ENABLED_TTS_PLUGINS

string

是

是

用于TTS的已激活插件包列表， 多個(gè)插件包以空格分隔。

wireless

提供設(shè)置無(wú)線網(wǎng)絡(luò)信息的數(shù)據(jù)項(xiàng)。

屬性

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

名稱

類型

可讀

可寫(xiě)

說(shuō)明

BLUETOOTH_DISCOVER_ABILITY_STATUS

string

是

是

設(shè)備是否可以被其他設(shè)備通過(guò)藍(lán)牙發(fā)現(xiàn)或連接。

值為0表示設(shè)備不可以被連接或發(fā)現(xiàn)；

值為1表示設(shè)備可以被連接但不可以被發(fā)現(xiàn)；

值為2表示設(shè)備可以被連接和發(fā)現(xiàn)。

BLUETOOTH_DISCOVER_TIMEOUT

string

是

是

可以通過(guò)藍(lán)牙發(fā)現(xiàn)設(shè)備的持續(xù)時(shí)間（以秒為單位）。

這段時(shí)間之后，設(shè)備不可以被藍(lán)牙搜尋到。

AIRPLANE_MODE_RADIOS

string

是

是

啟用飛行模式時(shí)要禁用的無(wú)線電信號(hào)列表。

多個(gè)無(wú)線電信號(hào)用逗號(hào) (,) 分隔。取值包括以下常量：BLUETOOTH_RADIO、 CELL_RADIO、 NFC_RADIO、 WIFI_RADIO。

BLUETOOTH_RADIO

string

是

否

常量，作為AIRPLANE_MODE_RADIOS的取值時(shí)表示藍(lán)牙在飛行模式下禁用。

CELL_RADIO

string

是

否

常量，作為AIRPLANE_MODE_RADIOS的取值時(shí)表示蜂窩無(wú)線電在飛行模式下禁用。

NFC_RADIO

string

是

否

常量，作為AIRPLANE_MODE_RADIOS的取值時(shí)表示NFC在飛行模式下禁用。

WIFI_RADIO

string

是

否

常量，作為AIRPLANE_MODE_RADIOS的取值時(shí)表示W(wǎng)i-Fi在飛行模式下禁用。

BLUETOOTH_STATUS

string

是

是

藍(lán)牙是否可用。

值為true表示藍(lán)牙可用；

值為false表示藍(lán)牙不可用。

OWNER_LOCKDOWN_WIFI_CFG

string

是

是

是否應(yīng)鎖定由設(shè)備所有者的應(yīng)用程序創(chuàng)建的Wi-Fi配置。

值為true表示W(wǎng)i-Fi配置應(yīng)該被鎖定；

值為false表示不應(yīng)該被鎖定。

WIFI_DHCP_MAX_RETRY_COUNT

string

是

是

嘗試從DHCP服務(wù)器獲取 IP 地址的最大次數(shù)。

WIFI_TO_MOBILE_DATA_AWAKE_TIMEOUT

string

是

是

Wi-Fi連接斷開(kāi)后等待移動(dòng)數(shù)據(jù)連接建立時(shí)保持喚醒鎖的最長(zhǎng)時(shí)間。

WIFI_STATUS

string

是

是

Wi-Fi是否可用。

值為true表示W(wǎng)i-Fi可用；

值為false表示W(wǎng)i-Fi不可用。

WIFI_WATCHDOG_STATUS

string

是

是

Wi-Fi的WatchDog是否可用。

值為true表示可用；

值為false表示不可用。

settings.enableAirplaneMode

enableAirplaneMode(enable: boolean, callback: AsyncCallback<void>): void

啟用或禁用飛行模式。使用callback異步回調(diào)。

此接口暫不支持。

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

enable

boolean

是

是否開(kāi)啟飛行模式。true表示開(kāi)啟，false表示禁用。

callback

AsyncCallback<void>

是

回調(diào)函數(shù)。

示例：

  1. let isEnabled = true;
  2. settings.enableAirplaneMode(isEnabled, (err) => {
  3.     if (err) {
  4.         console.log('Failed to enable AirplaneMode.');
  5.         return;
  6.     }
  7.     console.log('Return true if enable.');
  8. })

settings.enableAirplaneMode

enableAirplaneMode(enable: boolean): Promise<void>

啟用或禁用飛行模式。使用Promise異步回調(diào)。

此接口暫不支持。

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

enable

boolean

是

是否開(kāi)啟飛行模式。true表示開(kāi)啟，false表示禁用。

返回值：

類型

說(shuō)明

Promise<void>

無(wú)返回結(jié)果的Promise對(duì)象。

示例：

  1. let isEnabled = true;
  2. settings.enableAirplaneMode(isEnabled).then(() => {
  3.   console.log('Succeeded in enabling AirplaneMode.');
  4. }).catch((err) => {
  5.   console.log(`Failed to enable AirplaneMode. Cause: ${err}`);
  6. })

settings.canShowFloating

canShowFloating(callback: AsyncCallback<boolean>): void

檢查應(yīng)用是否能夠以懸浮窗形式顯示。使用callback異步回調(diào)。

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

callback

AsyncCallback<boolean>

是

回調(diào)函數(shù)。

返回true，表示應(yīng)用能夠以懸浮窗形式顯示；返回false，則表示不能。

示例：

  1. settings.canShowFloating((status) => {
  2.     console.log('Checks whether a specified application can show as float window.');
  3. });

settings.canShowFloating

canShowFloating(): Promise<boolean>

檢查應(yīng)用是否能夠以懸浮窗形式顯示。使用Promise異步回調(diào)。

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

返回值：

類型

說(shuō)明

Promise<boolean>

Promise對(duì)象。

返回true，表示應(yīng)用能夠以懸浮窗形式顯示；返回false，則表示不能。

示例：

  1. settings.canShowFloating().then((status) => {
  2.     console.log('Checks whether a specified application can show as float window.');
  3. });

settings.getUriSync8+

getUriSync(name: string): string

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

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

name

string

是

數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種：

- 上述任意一個(gè)數(shù)據(jù)庫(kù)中已存在的數(shù)據(jù)項(xiàng)。

- 開(kāi)發(fā)者自行添加的數(shù)據(jù)項(xiàng)。

返回值：

類型

說(shuō)明

string

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

示例：

  1. // 獲取數(shù)據(jù)項(xiàng)的URI
  2. let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);

setting.getURI(deprecated)

getURI(name: string, callback: AsyncCallback<object>): void

獲取數(shù)據(jù)項(xiàng)的URI。使用callback異步回調(diào)。

說(shuō)明

從 API version 7開(kāi)始支持，從API version 9開(kāi)始廢棄。

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

name

string

是

數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種：

- 上述任意一個(gè)數(shù)據(jù)庫(kù)中已存在的數(shù)據(jù)項(xiàng)。

- 開(kāi)發(fā)者自行添加的數(shù)據(jù)項(xiàng)。

callback

AsyncCallback<object>

是

回調(diào)函數(shù)。獲取數(shù)據(jù)項(xiàng)的URI。

示例：

  1. settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri) => {
  2.     console.log(`callback:uri -> ${JSON.stringify(uri)}`)
  3. })

setting.getURI(deprecated)

getURI(name: string): Promise<object>

獲取數(shù)據(jù)項(xiàng)的URI。使用Promise異步回調(diào)。

說(shuō)明

從 API version 7開(kāi)始支持，從API version 9開(kāi)始廢棄。

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

name

string

是

數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種：

- 上述任意一個(gè)數(shù)據(jù)庫(kù)中已存在的數(shù)據(jù)項(xiàng)。

- 開(kāi)發(fā)者自行添加的數(shù)據(jù)項(xiàng)。

返回值：

類型

說(shuō)明

Promise<object>

Promise對(duì)象。返回獲取的數(shù)據(jù)項(xiàng)的URI。

示例：

  1. settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri) => {
  2.     console.log(`promise:uri -> ${JSON.stringify(uri)}`)
  3. })

setting.getValue(deprecated)

getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback<object>): void

獲取數(shù)據(jù)庫(kù)中指定數(shù)據(jù)項(xiàng)的值。使用callback異步回調(diào)。

說(shuō)明

從 API version 7開(kāi)始支持，從API version 9開(kāi)始廢棄。

模型約束：此接口僅可在FA模型下使用。

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

dataAbilityHelper

DataAbilityHelper

是

數(shù)據(jù)管理輔助類。

name

string

是

數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種：

- 上述任意一個(gè)數(shù)據(jù)庫(kù)中已存在的數(shù)據(jù)項(xiàng)。

- 開(kāi)發(fā)者自行添加的數(shù)據(jù)項(xiàng)。

callback

AsyncCallback<object>

是

使用callback方式獲取數(shù)據(jù)項(xiàng)的值。

示例：

  1. import featureAbility from '@ohos.ability.featureAbility';
  2. 

  3. let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
  4. let helper = featureAbility.acquireDataAbilityHelper(uri);
  5. settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => {
  6.     if (err) {
  7.         console.error(`Failed to get the setting. ${err.message} `);
  8.         return;
  9.     }
  10.     console.log(`callback:value -> ${JSON.stringify(value)}`)
  11. });

setting.getValue(deprecated)

getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise<object>

獲取數(shù)據(jù)庫(kù)中指定數(shù)據(jù)項(xiàng)的值。使用Promise異步回調(diào)。

說(shuō)明

從 API version 7開(kāi)始支持，從API version 9開(kāi)始廢棄。

模型約束：此接口僅可在FA模型下使用。

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

dataAbilityHelper

DataAbilityHelper

是

數(shù)據(jù)管理輔助類。

name

string

是

數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種：

- 上述任意一個(gè)數(shù)據(jù)庫(kù)中已存在的數(shù)據(jù)項(xiàng)。

- 開(kāi)發(fā)者自行添加的數(shù)據(jù)項(xiàng)。

返回值：

類型

說(shuō)明

Promise<object>

Promise對(duì)象。返回獲得的數(shù)據(jù)項(xiàng)的值。

示例：

  1. import featureAbility from '@ohos.ability.featureAbility';
  2. 

  3. let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
  4. let helper = featureAbility.acquireDataAbilityHelper(uri);
  5. settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => {
  6.     console.log(`promise:value -> ${JSON.stringify(value)}`)
  7. });

settings.getValueSync(deprecated)

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

獲取數(shù)據(jù)項(xiàng)的值。此方法相較getValue為同步方法。

說(shuō)明

從 API version 8開(kāi)始支持，從API version 9開(kāi)始廢棄。

模型約束：此接口僅可在FA模型下使用。

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

dataAbilityHelper

DataAbilityHelper

是

數(shù)據(jù)管理輔助類。

name

string

是

數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種：

- 上述任意一個(gè)數(shù)據(jù)庫(kù)中已存在的數(shù)據(jù)項(xiàng)。

- 開(kāi)發(fā)者自行添加的數(shù)據(jù)項(xiàng)。

defValue

string

是

默認(rèn)值。由開(kāi)發(fā)者設(shè)置，當(dāng)未從數(shù)據(jù)庫(kù)中查詢到該數(shù)據(jù)時(shí)，表示返回該默認(rèn)值。

返回值：

類型

說(shuō)明

string

返回?cái)?shù)據(jù)項(xiàng)的值。

示例：

  1. import featureAbility from '@ohos.ability.featureAbility';
  2. 

  3. //獲取數(shù)據(jù)項(xiàng)亮度的值（該數(shù)據(jù)項(xiàng)在數(shù)據(jù)庫(kù)中已存在）
  4. let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
  5. let helper = featureAbility.acquireDataAbilityHelper(uri);
  6. let value = settings.getValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '10');

settings.setValueSync(deprecated)

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

設(shè)置數(shù)據(jù)項(xiàng)的值。此方法相較setValue為同步方法。

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

說(shuō)明

從 API version 8開(kāi)始支持，從API version 9開(kāi)始廢棄。

模型約束：此接口僅可在FA模型下使用。

需要權(quán)限：ohos.permission.MANAGE_SECURE_SETTINGS，僅系統(tǒng)應(yīng)用可用。

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

參數(shù)：

參數(shù)名

類型

必填

說(shuō)明

dataAbilityHelper

DataAbilityHelper

是

數(shù)據(jù)管理輔助類。

name

string

是

數(shù)據(jù)項(xiàng)的名稱。數(shù)據(jù)項(xiàng)名稱分為以下兩種：

- 上述任意一個(gè)數(shù)據(jù)庫(kù)中已存在的數(shù)據(jù)項(xiàng)。

- 開(kāi)發(fā)者自行添加的數(shù)據(jù)項(xiàng)。

value

string

是

數(shù)據(jù)項(xiàng)的具體數(shù)值。取值范圍隨業(yè)務(wù)變動(dòng)。

返回值：

類型

說(shuō)明

boolean

返回設(shè)置數(shù)據(jù)項(xiàng)的值是否成功的結(jié)果。true表示設(shè)置成功，false表示設(shè)置失敗。

示例：

  1. import featureAbility from '@ohos.ability.featureAbility';
  2. 

  3. //更新數(shù)據(jù)項(xiàng)亮度的值（該數(shù)據(jù)項(xiàng)在數(shù)據(jù)庫(kù)中已存在，故setValueSync方法將更新該數(shù)據(jù)項(xiàng)的值）
  4. let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
  5. let helper = featureAbility.acquireDataAbilityHelper(uri);
  6. let ret = settings.setValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100');
以上內(nèi)容是否對(duì)您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)