ドキュメント

ミニメッセージを表示する

ソーシャルアプリでは、アプリケーション内でのさまざまな動作に合わせて、簡易的なメッセージを表示させることができます。この機能のことをミニメッセージと呼びます。

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

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

ミニメッセージの利用宣言

OpenSocial で提供しているミニメッセージ機能を利用するためには、以下のようにガジェットXMLを記述して minimessage フィーチャーを有効にする必要があります。

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

閉じるボタンが付いているミニメッセージの表示

表示するミニメッセージに、ユーザーの操作で閉じることのできるボタンを付けることができます。このミニメッセージは、ユーザーが閉じるボタンをクリックするまで表示されたままになります。

閉じるボタンが付いてるミニメッセージを表示するコードは以下のとおりです。

var msg = new gadgets.MiniMessage();
msg.createDismissibleMessage("メッセージを送信しました。");
  • gadgets.MiniMessage.createDismissibleMessage() メソッドで閉じるボタン付きのミニメッセージを表示します。
  • 第二引数に閉じるボタンがクリックされた際に処理を行うコールバック関数を指定できます。

指定時間後に消去するミニメッセージの表示

ユーザーの操作ではなく、自動的に消去されるミニメッセージを表示することもできます。このミニメッセージは、指定した時間が経過すると自動的に消去されます。

指定時間後に消去するミニメッセージを表示するコードは以下のとおりです。

var msg = new gadgets.MiniMessage();
msg.createTimerMessage("メッセージを送信しました。", 5);
  • gadgets.MiniMessage.createTimerMessage() メソッドで指定時間後に消去するミニメッセージを表示します。
  • 第二引数に消去するまでの時間(秒)を指定します。
  • 第三引数に指定時間後に処理を行うコールバック関数を指定できます。

プログラムから消去するミニメッセージの表示

プログラムで指定したタイミングで消去されるミニメッセージを表示することもできます。このミニメッセージは、プログラムで指定されない限り表示されたままになります。

プログラムから消去するミニメッセージを表示するコードは以下のとおりです。

var msg = new gadgets.MiniMessage();
var staticMsg = msg.createStaticMessage("メッセージを送信しました。");
// ...
// ミニメッセージ消去
msg.dismissMessage(staticMsg);
  • gadgets.MiniMessage.createStaticMessage() メソッドでプログラムから消去するミニメッセージを表示します。
  • 第二引数に消去するプログラムが呼ばれた際の処理を行うコールバック関数を指定できます。