ISharedPreferences インターフェイス

定義

Context#getSharedPreferencesによって返される基本設定データにアクセスおよび変更するためのインターフェイス。

[Android.Runtime.Register("android/content/SharedPreferences", "", "Android.Content.ISharedPreferencesInvoker")]
public interface ISharedPreferences : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/content/SharedPreferences", "", "Android.Content.ISharedPreferencesInvoker")>]
type ISharedPreferences = interface
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
属性
実装

注釈

Context#getSharedPreferencesによって返される基本設定データにアクセスおよび変更するためのインターフェイス。 特定の基本設定のセットには、すべてのクライアントが共有するこのクラスの 1 つのインスタンスがあります。 基本設定の変更は、 Editor オブジェクトを経由して、ユーザー設定の値がストレージにコミットされたときに一貫した状態と制御を維持する必要があります。 さまざまな get メソッドから返されるオブジェクトは、アプリケーションによって不変として扱われる必要があります。

SharedPreferences は、ユーザーがアプリを体験する方法に関するデータを格納するのに最適です。たとえば、ユーザーが特定の UI テーマを好むか、リスト内の特定のコンテンツを表示するかグリッドで表示するかなどです。 このため、SharedPreferences は、変更が永続的に永続化される前に、Editor#commit() committedEditor#apply() appliedemEditorimmediately</em> による変更<または>を反映します。 アプリのクラッシュや終了などの状況では、 OnSharedPreferenceChangeListener が変更が成功したことが報告された場合でも、これらの変更が失われる可能性があります。 SharedPreferences は、ユーザーのセキュリティやプライバシー設定などの以前の状態へのこの種のロールバックの影響を受けやすいデータを格納する場合には推奨されません。 その他の高度なデータ永続化オプションについては、「 Room または DataStore」を参照してください。

<em>Note:</em> 一般的な実装では、ホスト アクティビティが停止したときに、基本設定ファイルに対する未処理の編集がディスクに保持されることを保証します。 状況によっては (ホスト アクティビティから移動する直前に多数の Editor#commit() 操作や Editor#apply() 操作を実行する場合など)、ライフサイクル移行イベント中にメイン スレッドがブロックされたり、関連する ANR エラーが発生したりする可能性があります。 詳細については、 Editor#commit()Editor#apply()のドキュメントを参照してください。

<em>Note: このクラスは、複数のプロセス間での使用をサポートしていません。</em>

<div class="special reference"><h3>Developer Guides</h3>

SharedPreferences の使用の詳細については、 Data Storage 開発者ガイドを参照してください。

</部>

Javaドキュメント。

このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。

プロパティ

名前 説明
All

基本設定からすべての値を取得します。

Handle

基になる Android オブジェクトの JNI 値を取得します。

(継承元 IJavaObject)
JniIdentityHashCode

ラップされたインスタンスの java.lang.System.identityHashCode() の値を返します。

(継承元 IJavaPeerable)
JniManagedPeerState

マネージド ピアの状態。

(継承元 IJavaPeerable)
JniPeerMembers

メンバー アクセスと呼び出しのサポート。

(継承元 IJavaPeerable)
PeerReference

ラップされたJava オブジェクト インスタンスのJniObjectReferenceを返します。

(継承元 IJavaPeerable)

メソッド

名前 説明
Contains(String)

基本設定に基本設定が含まれているかどうかを確認します。

Disposed()

インスタンスが破棄されたときに呼び出されます。

(継承元 IJavaPeerable)
DisposeUnlessReferenced()

このインスタンスへの未処理の参照がない場合は、 Dispose()を呼び出します。それ以外の場合は何も実行しません。

(継承元 IJavaPeerable)
Edit()

これらの環境設定用の新しいエディターを作成します。これにより、環境設定のデータを変更し、それらの変更を SharedPreferences オブジェクトにアトミックにコミットできます。

Finalized()

インスタンスが終了したときに呼び出されます。

(継承元 IJavaPeerable)
GetBoolean(String, Boolean)

基本設定からブール値を取得します。

GetFloat(String, Single)

基本設定から float 値を取得します。

GetInt(String, Int32)

基本設定から int 値を取得します。

GetLong(String, Int64)

設定から長い値を取得します。

GetString(String, String)

環境設定から文字列値を取得します。

GetStringSet(String, ICollection<String>)

環境設定から文字列値のセットを取得します。

RegisterOnSharedPreferenceChangeListener(ISharedPreferencesOnSharedPreferenceChangeListener)

基本設定に変更が発生したときに呼び出されるコールバックを登録します。

SetJniIdentityHashCode(Int32)

JniIdentityHashCodeによって返される値を設定します。

(継承元 IJavaPeerable)
SetJniManagedPeerState(JniManagedPeerStates)

Context#getSharedPreferencesによって返される基本設定データにアクセスおよび変更するためのインターフェイス。

(継承元 IJavaPeerable)
SetPeerReference(JniObjectReference)

PeerReferenceによって返される値を設定します。

(継承元 IJavaPeerable)
UnregisterFromRuntime()

ランタイムが将来の Java.Interop.JniRuntime+JniValueManager.PeekValue 呼び出しから返されないように、このインスタンスの登録を解除します。

(継承元 IJavaPeerable)
UnregisterOnSharedPreferenceChangeListener(ISharedPreferencesOnSharedPreferenceChangeListener)

前のコールバックの登録を解除します。

拡張メソッド

名前 説明
GetJniTypeName(IJavaPeerable)

インスタンス selfの型の JNI 名を取得します。

JavaAs<TResult>(IJavaPeerable)

selfを強制的にTResult入力し、強制型がJava側で有効であることを確認します。

JavaCast<TResult>(IJavaObject)

Android ランタイムチェック型変換を実行します。

JavaCast<TResult>(IJavaObject)

Context#getSharedPreferencesによって返される基本設定データにアクセスおよび変更するためのインターフェイス。

TryJavaCast<TResult>(IJavaPeerable, TResult)

selfを強制的にTResult入力し、強制型がJava側で有効であることを確認します。

適用対象