跳到主要内容

opensocial


メソッド​

opensocial.requestSendMessage​

<static> requestSendMessage(recipients, message, opt_callback, opt_params)

指定したユーザーに対してメッセージを送信するようにリクエストします。

パラメータ​
名前型説明
recipientsStringメッセージの送り先のユーザーID、またはOWNERのみ。
messageopensocial.Message指定されたユーザーに送信される Message オブジェクト
opt_callbackFunctionリクエストが完了したときに呼び出されるコールバック関数
opt_paramsopensocial.NavigationParameters要求時、または要求がアクセプトされたときにユーザーを移動する場所を示すパラメータ
返り値​

なし

メッセージ送信時の制限事項​
  • ユーザーIDの配列指定やグループへ送ることはできません。
  • 自分自身に送ることはできません。
  • Sandbox ではモバ友のみにしか送れません。
  • BlackList 対象のユーザーには送れません。
  • その他 Mobage のミニメールの制限がそのまま適用されます。
サンプル​
var params = {};
params[opensocial.Message.Field.TITLE] = "Hello";
var msg = opensocial.newMessage("こんにちは!", params);
var recipient = "xxxxxx";
opensocial.requestSendMessage(recipient, msg,
function (res) {
if (res.hadError()) {
// ...
} else {
// ...
}
}
);

opensocial.requestShareApp​

<static> requestShareApp(recipients, reason, opt_callback, opt_params)

指定したユーザーとこのアプリを共有するようにリクエストします。

パラメータ​
名前型説明
recipientsStringVIEWER_FRIENDS のみ指定可
reasonopensocial.Messagetitle, bodyを指定するための Message オブジェクト
opt_callbackFunctionリクエストが完了したときに呼び出されるコールバック関数
返り値​

なし

サンプル​
var params ={};
params[opensocial.Message.Field.TITLE] = "新作Gameへの招待";
var msg =opensocial.newMessage("僕と一緒にExampleGameをプレイしよう!今ならキャンペーン中!", params);
opensocial.requestShareApp("VIEWER_FRIENDS", msg,
function(res) {
if (res.hadError()) {
// ...
} else {
// ...
}
}
);

opensocial.requestCreateActivity​

<static> requestCreateActivity(activity, priority, opt_callback)

指定したアクティビティの作成をリクエストします。
priorityにopensocial.CreateActivityPriority.LOWを指定した場合はユーザからの応答を待たずに優先度の低いActivityを作成し、opensocial.CreateActivityPriority.HIGHを指定した場合はユーザにアクティビティ送信の可否を訊ねるポップアップを表示し、ユーザの許可を得てから優先度の高いActivityを作成します。ユーザがアクティビティ送信を許可しなかった場合、アクティビティの送信はキャンセルされます。

パラメータ​
名前型説明
activityopensocial.Activity作成する Activity オブジェクト
priorityopensocial.CreateActivityPriorityリクエストの優先度
opt_callbackFunctionリクエストが完了したときに呼び出されるコールバック関数
返り値​

なし

サンプル​
var params ={};
params[opensocial.Activity.Field.TITLE] ="Hello";
var activity = opensocial.newActivity(params);
opensocial.requestCreateActivity(activity, opensocial.CreateActivityPriority.LOW,
function(res) {
if (res.hadError()) {
// ...
} else {
// ...
}
}
);

opensocial.hasPermission​

サポートされていません。

opensocial.requestPermission​

サポートされていません。

opensocial.getEnvironment​

サポートされていません。

opensocial.newDataRequest​

<static> opensocial.DataRequest newDataRequest()

DataRequest オブジェクトを作成します。

パラメータ​

なし

返り値​
型説明
opensocial.DataRequest新しい DataRequest オブジェクト
サンプル​
var req = opensocial.newDataRequest();

opensocial.newActivity​

<static> opensocial.Activity newActivity(params)

Activity オブジェクトを作成します。

パラメータ​
名前型説明
paramsMap.<opensocial.Activity.Field/Object>Activity オブジェクトに設定すべきその他のフィールド。opensocial.Activity.Field.TITLE を指定可。
返り値​
型説明
opensocial.ActivityActivity オブジェクト
サンプル​
var params = {};
params[opensocial.Activity.Field.TITLE] = "Hello";
var activity = opensocial.newActivity(params);

opensocial.newMediaItem​

<static> opensocial.MediaItem newMediaItem(mime_type, url, opt_params)

MediaItem オブジェクトを作成します。

パラメータ​
名前型説明
mime_typeStringメディアの MIME タイプ
urlStringメディアのURL
opt_paramsMap.<opensocial.MediaItem.Field/Object>MediaItem オブジェクトに設定すべきその他のフィールド
返り値​
型説明
opensocial.MediaItemMediaItem オブジェクト
サンプル​
var mediaItem = opensocial.newMediaItem("image/gif", "http://example.com/foo.gif");

opensocial.newMessage​

<static> opensocial.Message newMessage(body, opt_params)

Message オブジェクトを作成します。

パラメータ​
名前型説明
bodyStringメッセージの本文
opt_paramsMap.<opensocial.Message.Field/Object>Message オブジェクトに設定すべきその他のフィールド
返り値​
型説明
opensocial.Message新しい Message オブジェクト
サンプル​
var params = {};
params[opensocial.Message.Field.TITLE] = "Hello";
var message = opensocial.newMessage("こんにちは!", params);

opensocial.newIdSpec​

<static> opensocial.IdSpec newIdSpec(parameters)

IdSpce オブジェクトを作成します。

パラメータ​
名前型説明
patametersMap.<opensocial.IdSpec.Field/Object>IdSpec オブジェクトに設定すべきその他のフィールド
返り値​
型説明
opensocial.IdSpec新しい IdSpec オブジェクト
サンプル​
var params = {};
params[opensocial.IdSpec.Field.USER_ID] = opensocial.IdSpec.PersonId.VIEWER;
params[opensocial.IdSpec.Field.GROUP_ID] = opensocial.IdSpec.GroupId.FRIENDS;
var id_spec = opensocial.newIdSpec(params);

opensocial.newNavigationParameters​

サポートされていません。


更新履歴​

  • 2012/12/20
    • opensocial.requestShareApp の説明・サンプルを修正
  • 2011/01/24
    • opensocial.requestSendMessage のサンプルを修正
  • 2010/12/17
    • opensocial.requestCreateActivityに関して、priorityについての記述を追加