モバ友をアプリケーションに招待する
アプリケーションからモバ友を招待するには以下のようにします。
opensocial.requestShareApp(
"VIEWER_FRIENDS",
null,
function(response) {
if (response.hadError()) {
// error
} else {
// ...
}
}
);
- opensocial.requestShareApp() を呼ぶことによってモバ友をアプリケーションに招待することができます。
- 引数は以下になります。
- 招待対象。VIEWER はモバ友に限定されるので、"VIEWER.FRIENDS"を固定で指定します。
- nullを指定します。この引数は無視されます。
- 処理終了後に呼ばれるコールバック関数。
- opensocial.requestShareApp() メソッドを呼んで招待するユーザーを選択するポップアップ画面を表示します。
- ユーザーが招待をしてサーバー要求の処理が完了すると、指定されたコールバック関数が要求結果を含む opensocial.ResponseItemクラスのオブジェクトを引数として実行されます。
- DataResponse に格納されているデータを処理します。
- 招待されたユーザーには招待ミニメールが送信されます。
コールバック処理について
ユーザが友達招待を完了した後、またはダイヤログの閉じるボタンを押した後にコールバック関数が呼び出されます。サンプルではユーザが友達招待を完了するとミニメ送信先ユーザIDが返り、閉じるボタンで終了された場合の recipientIds.length は 0 を返します。
opensocial.requestShareApp( "VIEWER_FRIENDS", null, function(response) {
if (response.hadError()) {
// error
} else {
var recipientIds = response.getData()["recipientIds"];
if (recipientIds.length === 0){
// ダイヤログを閉じてキャンセルされた処理
} else{
// 友達招待が行われた処理
}
}
}
);
デフォルトメッセージを指定する
opensocial.newMessage() にメッセージボディとタイトルを含むパラメータを渡してopensocial.Messageオブジェクトを作成します。
生成したopensocial.Messageオブジェクトをopensocial.requestShareAppの第2引数にしてデフォルトのメッセージを指定します。
opensocial.Messageオブジェクト作成時のparamsで指定できるパラメータは下記の通りです。
| キー | 説明 |
|---|---|
| opensocial.Message.Field.TITLE | デフォルトの件名 |
| opensocial.Message.Field.BODY | デフォルトの本文 |
- 件名は全角30文字以内、絵文字は利用できません
- 本文は全角500文字以内、URLやリンクを含めることはできません
- 件名、本文ともにmobageにおける禁止ワードが含まれている場合は、デフォルトの文言に修正されます。事前にチェックを行いたい場合はNGWord APIをご利用下さい。
var params = {};
params[opensocial.Message.Field.TITLE] = "新作ExampleGameへの招待";
var body = "僕と一緒にExampleGameをプレイしよう!今ならキャンペーン中!";
var message = opensocial.newMessage(body, params);
opensocial.requestShareApp("VIEWER_FRIENDS", message, function(response) {
if (response.hadError()) {
// error
} else {
// ...
}
});
更新履歴
- 2012/12/20
- デフォルトメッセージの指定について記述を追加
- 2012/12/10
- コールバック処理に関する記述を追加