nsIContentPrefService

nsIContentPrefService は、拡張機能やブラウザのコードにおいて、特定の URI のための設定を保存する方法を提供します。設定項目はキーと値のペアで URI ごとに保存されます。使用例は Using content preferences を参照してください。

toolkit/components/contentprefs/public/nsIContentPrefService.idlScriptable

Please add a summary to this article.

最終更新: Gecko 1.9 (Firefox 3)

継承元: nsISupports

実装: @mozilla.org/content-pref/service;1。インスタンスを作成するには、以下のように記述します。

var prefService = Components.classes["@mozilla.org/content-pref/service;1"]
                  .getService(Components.interfaces.nsIContentPrefService);

メソッドの概要

void addObserver(in AString aName, in nsIContentPrefObserver aObserver);

nsIVariant getPref(in nsIURI aURI, in AString aName);

nsIPropertyBag2 getPrefs(in nsIURI aURI);

boolean hasPref(in nsIURI aURI, in AString aName);

void removeObserver(in AString aName, in nsIContentPrefObserver aObserver);

void removePref(in nsIURI aURI, in AString aName);

void setPref(in nsIURI aURI, in AString aName, in nsIVariant aValue);

属性

属性	型	説明
`grouper`	`nsIContentURIGrouper`	URI が属するグループを判別するのにサービスが使用するコンポーネント。デフォルトでは、これは完全なホスト名で (つまりサイトごとに) URI をグループ化する「hostname grouper」になります。

メソッド

getPref()

特定の URI のために保存された設定の値を返します。

 nsIVariant getPref(
   in nsIURI aURI,
   in AString aName
 );

引数

<tt>aURI</tt>: 設定を取得する URI。グローバル設定空間から設定を取得する場合は null を指定します。グローバル設定はすべての URI に適用されます。
<tt>aName</tt>: 値を取得する設定の名前。

戻り値

設定の値が返されます。これには、文字列、整数値、真偽値、あるいはその他の値が含まれる可能性があります。指定された名前で保存されている値がなく、設定の値が null (nsIDataType:VTYPE_EMPTY) もしくは undefined (nsIDataType:VTYPE_VOID) であった場合、結果は null になる場合があります。

setPref()

特定の URI のために設定の値を設定します。

 nsIVariant setPref(
   in nsIURI aURI,
   in AString aName,
   in nsIVariant aValue
 );

引数

<tt>aURI</tt>: 設定を保存する URI。グローバル設定空間にある設定を設定する場合は null を指定します。グローバル設定はすべての URI に適用されます。
<tt>aName</tt>: 値を設定する設定の名前。
<tt>aValue</tt>: 設定に割り当てる値。

hasPref()

特定の設定項目が存在するかどうかを判別します。

 boolean hasPref(
   in nsIURI aURI,
   in AString aName
 );

引数

<tt>aURI</tt>: 設定項目が存在するかどうかを判別する URI。グローバル設定空間にある設定を判別する場合は null を指定します。
<tt>aName</tt>: 設定項目が存在するかどうかを判別する設定の名前。

戻り値

設定が存在する場合は true、存在しなければ false。

removePref()

特定の設定項目を削除します。

 void removePref(
   in nsIURI aURI,
   in AString aName
 );

引数

<tt>aURI</tt>: 削除する設定の URI。グローバル設定空間にある設定を削除する場合は null を指定します。
<tt>aName</tt>: 削除する設定の名前。

getPrefs()

特定の URI のための設定とそれらの値をすべて含んだ nsIPropertyBag2 を返します。

 nsIPropertyBag2 getPrefs(
   in nsIURI aURI,
 );

引数

<tt>aURI</tt>: 取得したい設定の URI。グローバル設定空間にある設定を取得する場合は null を指定します。

戻り値

設定とそれらの値をすべて含んだ nsIPropertyBag2。

addObserver()

特定の設定の変更を監視するオブザーバを追加します。

 void addObserver(
   in AString aName,
   in nsIContentPrefObserver aObserver
 );

引数

<tt>aName</tt>: 監視を行う設定の名前。すべての設定の変更を監視する包括的オブザーバを追加する場合は null を指定します。
<tt>aObserver</tt>: 設定の値が変更された場合に通知を受ける nsIContentPrefObserver を実装したオブジェクトの名前。

removeObserver()

特定の設定の変更を監視している既存のオブザーバを削除します。

 void addObserver(
   in AString aName,
   in nsIContentPrefObserver aObserver
 );

引数

<tt>aName</tt>: 監視を停止する設定の名前。すべての設定の変更を監視する包括的オブザーバを削除する場合は null を指定します。
<tt>aObserver</tt>: 設定の値が変更された場合に通知を受けるオブザーバの名前。

nsIContentPrefObserver, Using content preferences