Xamarin.Essentials:Preferensi
Kelas Preferensi membantu menyimpan preferensi aplikasi di penyimpanan kunci/nilai.
Memulai
Untuk mulai menggunakan API ini, baca panduan memulai untuk Xamarin.Essentials memastikan pustaka diinstal dan disiapkan dengan benar di proyek Anda.
Menggunakan Preferensi
Tambahkan referensi ke Xamarin.Essentials di kelas Anda:
using Xamarin.Essentials;
Untuk menyimpan nilai untuk kunci tertentu dalam preferensi:
Preferences.Set("my_key", "my_value");
Untuk mengambil nilai dari preferensi atau default jika tidak diatur:
var myValue = Preferences.Get("my_key", "default_value");
Untuk memeriksa apakah kunci tertentu ada di preferensi:
bool hasKey = Preferences.ContainsKey("my_key");
Untuk menghapus kunci dari preferensi:
Preferences.Remove("my_key");
Untuk menghapus semua preferensi:
Preferences.Clear();
Tip
Metode di atas mengambil parameter opsional string
yang disebut sharedName
. Parameter ini digunakan untuk membuat kontainer tambahan untuk preferensi yang berguna dalam beberapa kasus penggunaan. Satu kasus penggunaan adalah ketika aplikasi Anda perlu berbagi preferensi di seluruh ekstensi atau ke aplikasi tonton. Silakan baca implementasi platform khusus di bawah ini.
Jenis data yang didukung
Jenis data berikut didukung di Preferensi:
- bool
- Double
- int
- float
- long
- tali
- DateTime
Integrasikan dengan Pengaturan Sistem
Preferensi disimpan secara asli, yang memungkinkan Anda untuk mengintegrasikan pengaturan Anda ke dalam pengaturan sistem asli. Ikuti dokumentasi dan sampel platform untuk diintegrasikan dengan platform:
Detail Implementasi
Nilai disimpan dalam format biner 64-bit (bilangan DateTime
bulat panjang) menggunakan dua metode yang ditentukan oleh DateTime
kelas: Metode ToBinary
ini digunakan untuk mengodekan DateTime
nilai, dan FromBinary
metode mendekode nilai. Lihat dokumentasi metode ini untuk penyesuaian yang mungkin dibuat untuk nilai yang didekodekan ketika DateTime
disimpan yang bukan nilai Waktu Universal Terkoordinasi (UTC).
Spesifikasi Implementasi Platform
Semua data disimpan ke Preferensi Bersama. Jika tidak sharedName
ada yang ditentukan, preferensi bersama default digunakan, jika tidak, nama digunakan untuk mendapatkan preferensi bersama privat dengan nama yang ditentukan.
Persistensi
Menghapus instalan aplikasi akan menyebabkan semua Preferensi dihapus, dengan pengecualian menjadi aplikasi yang menargetkan dan berjalan di Android 6.0 (API level 23) atau yang lebih baru yang menggunakan Pencadangan Otomatis. Fitur ini aktif secara default dan mempertahankan data aplikasi termasuk Preferensi Bersama, yang digunakan API Preferensi . Anda dapat menonaktifkannya dengan mengikuti dokumentasi Google.
Batasan
Saat menyimpan string, API ini dimaksudkan untuk menyimpan teks dalam jumlah kecil. Performa mungkin berupa subpar jika Anda mencoba menggunakannya untuk menyimpan teks dalam jumlah besar.