gadgets.Prefs

 概要     詳細

 gadgets.*reference インデックスに戻る

Class gadgets.Prefs

ユーザー設定、モジュールの寸法、およびメッセージへのアクセスを提供します。クライアントは、gadgets.Prefs のインスタンスを構築してモジュール ID を渡すことで、それぞれの設定にアクセスできます。次に例を示します。

var prefs = new gadgets.Prefs();
var name = prefs.getString("name");
var lang = prefs.getLang();

コンストラクタの概要

gadgets.Prefs(opt_moduleId)

新しい Prefs オブジェクトを作成します。

 

メソッドの概要

 Array.<String> getArray(key)

配列の設定を取得します。

 Boolean getBool(key)

ブール値の設定を取得します。

 String getCountry()

現在の国を取得します。ISO 3166-1 のアルファベット 2 文字のコードで返されます。

 Number getFloat(key)

浮動小数点の設定を取得します。

 Number getInt(key)

整数の設定を取得します。

 String getLang()

ガジェットでのレンダリングに使用すべき現在の言語を取得します。ISO 639-1 の言語コードで返されます。

 String, Number getModuleId()

現在のインスタンスのモジュール ID を取得します。

 String getMsg(key)

形式化されていないメッセージをフェッチします。

 String getMsgFormatted(key, opt_subst)

位置引数 opt_subst を含むメッセージ値が提供されている場合は、そのメッセージ値を返します。メッセージ値が提供されていない場合は、サンプル値を返します。メッセージが見つからない場合は、空の文字列を返します。

 String getString(key)

文字列の設定を取得します。

set(key, val)

設定を格納します。

setArray(key, val)

配列の設定を格納します。

 

コンストラクタの詳細

gadgets.Prefs

gadgets.Prefs(opt_moduleId)

新しい Prefs オブジェクトを作成します。

パラメータ:
String, Number opt_moduleId - Prefs オブジェクトの作成対象となるモジュールの ID を指定するパラメータ (オプション)。指 しない場合は、デフォルトのモジュール ID が使用されます。

メソッドの詳細

getArray

Array.<String> getArray(key)

配列の設定を取得します。リストとして宣言されていない UserPref 値は、要素が 1 つの配列として処理されます。

パラメータ:
String key - フェッチする設定です。

戻り値:
Array.<String> 設定。設定されていない場合は空の配列が返されます。

getBool

Boolean getBool(key)

ブール値の設定を取得します。

パラメータ:
String key - フェッチする設定です。

戻り値:
Boolean 設定。設定されていない場合は false が返されます。

getCountry

String getCountry()

現在の国を取得します。ISO 3166-1 のアルファベット 2 文字のコードで返されます。

戻り値:
String このモジュール インスタンスの国

getFloat

Number getFloat(key)

浮動小数点の設定を取得します。

パラメータ:
String key - フェッチする設定です。

戻り値:
Number 設定。設定されていない場合は 0 が返されます。

getInt

Number getInt(key)

整数の設定を取得します。

パラメータ:
String key - フェッチする設定です。

戻り値:
Number 設定。設定されていない場合は 0 が返されます。

getLang

String getLang()

ガジェットでのレンダリングに使用すべき現在の言語を取得します。ISO 639-1 の言語コードで返されます。

戻り値:
String このモジュール インスタンスの言語

getModuleId

String, Number getModuleId()

現在のインスタンスのモジュール ID を取得します。

戻り値:
String, Number このモジュール インスタンスのモジュール ID

getMsg

String getMsg(key)

形式化されていないメッセージをフェッチします。

パラメータ:
String key - フェッチするメッセージです。

戻り値:
String メッセージ

getMsgFormatted

String getMsgFormatted(key, opt_subst)

位置引数 opt_subst を含むメッセージ値が提供されている場合は、そのメッセージ値を返します。メッセージ値が提供されていない場合は、サンプル値を返します。メッセージが見つからない場合は、空の文字列を返します。

パラメータ:
String key - フェッチするメッセージです。
String opt_subst - メッセージに代入する文字列 (オプション) です。

戻り値:
String 形式化された文字列

getString

String getString(key)

文字列の設定を取得します。

パラメータ:
String key - フェッチする設定です。

戻り値:
String 設定。設定されていない場合は空の文字列が返されます。

set

set(key, val)

設定を格納します。この呼び出しを使用するには、ガジェットが setpref 機能を要求する必要があります。

注: ガジェットが配列を格納する必要がある場合は、この呼び出しではなく setArray を使用してください。

パラメータ:
String key - 格納する設定です。
Object val - 格納する値です。

setArray

setArray(key, val)

配列の設定を格納します。この呼び出しを使用するには、ガジェットが setpref 機能を要求する必要があります。

パラメータ:
String key - 格納する設定です。
Array val - 格納する値です。

---