メインコンテンツへスキップ

Settings

Settings は、iOS でのみ利用可能な永続的なキーと値のストアである NSUserDefaults のラッパーとして機能します。


リファレンス

Methods

clearWatch()

tsx
static clearWatch(watchId: number);

watchId は、サブスクリプションが最初に設定されたときに watchKeys() によって返される数値です。


get()

tsx
static get(key: string): any;

NSUserDefaults で指定された key の現在の値を取得します。


set()

tsx
static set(settings: Record<string, any>);

NSUserDefaults で1つ以上の値を設定します。


watchKeys()

tsx
static watchKeys(keys: string | array<string>, callback: () => void): number;

keys パラメータで指定されたいずれかのキーの値が NSUserDefaults で変更されたときに通知を受け取るようにサブスクライブします。サブスクライブを解除するために clearWatch() で使用できる watchId 番号を返します。

watchKeys() は、設計上、内部の set() 呼び出しを無視し、React Native コードの外部で行われた変更のみでコールバックを起動します。