オープンソースグループウェア「Aipo」提供終了のお知らせ

ドキュメント

表示カスタマイズの設定を行う

Aipoでは表示カスタマイズの設定を行うことにより、ポートレット単位での振る舞いを変更できます。 ソーシャルアプリでも、OpenSocial に規定されている UserPref という機能を利用することにより、通常のポートレットと同様に表示カスタマイズの設定を行うことができます。

なお、UserPref の設定値は URL のパラメータを通して、各アプリケーションに受け渡されます。パスワードなどの機密データの保存や、URL のパラメータを直接指定して利用されると困る場合には、UserPref の利用は向いていませんのでご注意ください。

OpenSocial 1.0 で規定されている仕様については下記をご覧ください。

http://opensocial-resources.googlecode.com/svn/spec/1.0/Core-Gadget.xml#UserPref

http://opensocial-resources.googlecode.com/svn/spec/1.0/Core-Gadget.xml#gadgets.Prefs

UserPrefの設定

UserPref で設定する項目については、以下のようにガジェットXMLで定義します。 XML の記述方法については、こちらをご確認ください。

<Module ...>
  <ModulePrefs>
     ...
  </ModulePrefs>
  <UserPref name="url" display_name="URL" datatype="string"/>
  <UserPref name="rows" display_name="表示件数" datatype="enum" default_value="5">
    <EnumValue value="5" display_value="5件"/>
    <EnumValue value="10"  display_value="10件"/>
    <EnumValue value="50"  display_value="50件"/>
  </UserPref>
     ...
</Module>

UserPrefの値を取得する

UserPref の値を取得するコードは以下のようになります。

var prefs = new gadgets.Prefs();
// url の値
var url = prefs.getString("url");
// rows の値
var rows = prefs.getInt("rows");

UserPref の値を保存する

UserPref の設定値をプログラムから保存する場合は、以下のようにガジェットXMLを記述して setprefs フィーチャーを有効にする必要があります。

<Module ...>
  <ModulePrefs>
    <Require feature="setprefs" />
     ...
  </ModulePrefs>
...
</Module>

UserPref の設定値を保存するコードは以下のようになります。

var prefs = new gadgets.Prefs();
prefs.set("url", "https://www.aipo.com");