mbga
- メソッド
- mbga.newFetchBlackListRequest
- mbga.requestFetchBlackList
- mbga.newFetchNGWordRequest
- mbga.requestCheckNGWord
- mbga.newCreateDiary
- mbga.requestCreateDiary
- mbga.newFetchAvatarRequest
- mbga.requestFetchAvatar
- mbga.newFetchTextDataRequest
- mbga.requestFetchTextData
- mbga.newCreateTextDataRequest
- mbga.requestCreateTextData
- mbga.newUpdateTextDataRequest
- mbga.requestUpdateTextData
- mbga.newRemoveTextDataRequest
- mbga.requestRemoveTextData
- mbga.newFriendRequest
- mbga.requestFriendRequest
メソッド
mbga.newFetchBlackListRequest
<static> Object mbga.newFetchBlackListRequest(idSpec, opt_params)
ブラックリストに登録しているユーザー一覧を取得する為のリクエストを作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| idSpec | opensocial.IdSpec | – |
| opt_params | Map<mbga.BlackListRequestFields, Object> | – |
返り値
| 型 | 説明 |
|---|---|
| Object | リクエストオブジェクト |
サンプル
var idSpec = opensocial.newIdSpec();
idSpec.setField(opensocial.IdSpec.Field.USER_ID, opensocial.IdSpec.PersonId.VIEWER);
idSpec.setField(opensocial.IdSpec.Field.GROUP_ID, opensocial.IdSpec.GroupId.ALL); // ALLのみが許可されています
var opt_params = {};
var req = opensocial.newDataRequest();
req.add( mbga.newFetchBlackListRequest(idSpec, opt_params), "blacklist" );
req.send(function(response) {
if (response.hadError()) {
// error handling
}
var blacklist = response.get("blacklist").getData();
blacklist.each(function(entry) {
// entry is an instance of mbga.BlackList
gadgets.log( "id: " + entry.getId() + ", targetId: " + entry.getTargetId() );
});
});
mbga.requestFetchBlackList
<static> void mbga.requestFetchBlackList(idSpec, opt_params, callback)
ブラックリストに登録しているユーザー一覧を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| idSpec | opensocial.IdSpec | – |
| opt_params | Map<mbga.BlackListRequestFields, Object> | – |
| callback | function | – |
返り値
なし
サンプル
var idSpec = opensocial.newIdSpec();
idSpec.setField(opensocial.IdSpec.Field.USER_ID, [ opensocial.IdSpec.PersonId.VIEWER, opensocial.IdSpec.PersonId.OWNER ]);
idSpec.setField(opensocial.IdSpec.Field.GROUP_ID, opensocial.IdSpec.GroupId.ALL);
var opt_params = {};
opt_params[mbga.BlackListRequestFields.PERSON_ID] = [10902, 10345]; // optional
opt_params[mbga.BlackListRequestFields.FIELDS] = [mbga.BlackList.Field.TARGET_ID]; // optional
mbga.requestFetchBlackList(idSpec, opt_params, function(response) {
if (response.hadError()) {
// error handling
}
var blacklist = response.getData();
blacklist.each(function(entry) {
// entry is an instance of mbga.BlackList
gadgets.log( "targetId: " + entry.getTargetId() );
});
});
mbga.newCheckNGWordRequest
<static> Object mbga.newCheckNGWordRequest(data)
渡された文字列中に NGWord が含まれるかどうかを調べる為のリクエストを生成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| data | String | NGWord が含まれているかどうか調べたい文字列 |
返り値
| 型 | 説明 |
|---|---|
| Object | リクエストオブジェクト |
サンプル
var text = '掲示板等に殺すなどの文字を入力してはいけません';
var req = opensocial.newDataRequest();
req.add( mbga.newCheckNGWordRequest(text), 'ngword' );
req.send(function(response) {
if (response.hadError()) {
// error handling
}
var ngword = response.get('ngword').getData();
if ( ngword.isValid() ) {
gadgets.log( text + ' is valid' );
}
else {
gadgets.log( text + ' is invalid' );
}
});
mbga.requestCheckNGWord
<static> void mbga.requestFetchBlackList(data, callback)
渡された文字列中に NGWord が含まれるかどうかを調べます。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| data | String | NGWord が含まれているかどうか調べたい文字列 |
| callback | function | – |
返り値
なし
サンプル
var text = '掲示板等に殺すなどの文字を入力してはいけません';
mbga.requestCheckNGWord(text, function(response) {
if (response.hadError()) {
// error handling
}
var ngword = response.getData();
if ( ngword.isValid() ) {
gadgets.log( text + ' is valid' );
}
else {
gadgets.log( text + ' is invalid' );
}
});
mbga.newCreateDiary
void mbga.newCreateDiary( opt_params )
日記を投稿します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| params | object | 投稿される日記へのパラメータです |
返り値
なし
サンプル
var mediaItem = opensocial.newMediaItem('image/png', 'http://example.com/kaizoku.png');
mediaItem.setField(opensocial.MediaItem.Field.TYPE, opensocial.MediaItem.Type.IMAGE);
var params = {};
params[mbga.Diary.Field.TITLE] = '海賊船を撃破した!'; // optional
params[mbga.Diary.Field.CONTENT] = '海賊船を撃破した記念写真です'; // optional
params[mbga.Diary.Field.MEDIA_ITEMS] = [ mediaItem ]; // optional
var diary = mbga.newCreateDiary(params);
mbga.requestCreateDiary
void mbga.requestCreateDiary( diary, callback )
日記を投稿します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| diary | mbga.Diary | 日記オブジェクト |
| callback | function | callback を受け取ります |
返り値
なし
サンプル
var mediaItem = opensocial.newMediaItem('image/png', 'http://example.com/kaizoku.png');
mediaItem.setField(opensocial.MediaItem.Field.TYPE, opensocial.MediaItem.Type.IMAGE);
var diary = mbga.newCreateDiary();
diary.setField( mbga.Diary.Field.TITLE, '海賊船を撃破した!' ); // optional
diary.setField( mbga.Diary.Field.CONTENT, '海賊船を撃破した記念写真です' ); // optional
diary.setField( mbga.Diary.Field.MEDIA_ITEMS, [ mediaItem ] ); // optional
mbga.requestCreateDiary( diary, function(response) {
if (response.hadError()) {
// error handling
}
var diary = response.getData();
gadgets.log( diary.getEntryURL() );
} );
mbga.newFetchAvatarRequest
<static> Object mbga.newFetchAvatarRequest(idSpec, opt_params)
アバター画像を取得する為のリクエストを作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| idSpec | opensocial.IdSpec | – |
| opt_params | Map<mbga.AvatarRequestFields, Object> | – |
返り値
| 型 | 説明 |
|---|---|
| Object | リクエストオブジェクト |
サンプル
var idSpec = opensocial.newIdSpec();
idSpec.setField(opensocial.IdSpec.Field.USER_ID, opensocial.IdSpec.PersonId.VIEWER);
idSpec.setField(opensocial.IdSpec.Field.GROUP_ID, opensocial.IdSpec.GroupId.SELF); // SELFのみが許可されています
var opt_params = {};
var req = opensocial.newDataRequest();
req.add( mbga.newFetchAvatarRequest(idSpec, opt_params), "avatar" );
req.send(function(response) {
if (response.hadError()) {
// error
} else {
var avatar = response.get("avatar").getData();
var url = avatar.getUrl();
// ...
}
});
mbga.requestFetchAvatar
<static> void mbga.requestFetchAvatar(idSpec, opt_params, callback)
アバター画像を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| idSpec | opensocial.IdSpec | – |
| opt_params | Map<mbga.AvatarRequestFields, Object> | – |
| callback | function | – |
返り値
なし
サンプル
var idSpec = opensocial.newIdSpec();
idSpec.setField(opensocial.IdSpec.Field.USER_ID, [ opensocial.IdSpec.PersonId.VIEWER, opensocial.IdSpec.PersonId.OWNER ]);
idSpec.setField(opensocial.IdSpec.Field.GROUP_ID, opensocial.IdSpec.GroupId.SELF);
var opt_params = {};
var avatar_params = {};
avatar_params[mbga.Enum.Avatar.SIZE] = mbga.Enum.Avatar.Size.LARGE; // optional
avatar_params[mbga.Enum.Avatar.EMOTION] = mbga.Enum.Avatar.Emotion.SHY; // optional
opt_params[mbga.AvatarRequestFields.AVATAR] = avatar_params;
mbga.requestFetchAvatar(idSpec, opt_params, function(response) {
if (response.hadError()) {
// error handling
} else {
var avatars = response.getData();
avatars.each(function(entry) {
// entry is an instance of mbga.BlackList
var url = entry.getUrl();
// ...
});
}
});
mbga.newFetchTextDataRequest
<static> Object mbga.newFetchTextDataRequest(opt_params)
テキストデータを取得する為のリクエストを作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| params | Map<mbga.TextDataRequestFields, Object> | – |
返り値
| 型 | 説明 |
|---|---|
| Object | リクエストオブジェクト |
サンプル
var params = {};
params[mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME] = "message_board"; // required
params[mbga.TextDataRequestFields.TEXTDATA_ID] = "4000"; // optional
var req = opensocial.newDataRequest();
req.add( mbga.newFetchTextDataRequest(params), "textdata" );
req.send(function(response) {
if (response.hadError()) {
// error
} else {
var textdata = response.get("textdata").getData();
var data = textdata.getData();
// ...
}
});
mbga.requestFetchTextData
<static> void mbga.requestFetchTextData(params, callback)
テキストデータを取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| params | Map<mbga.TextDataRequestFields, Object> | – |
| callback | function | – |
返り値
なし
サンプル
var params = {};
params[mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME] = "message_board"; // required
params[mbga.TextDataRequestFields.SORT_BY] = mbga.TextDataRequest.SortBy.UPDATED; // optional
params[mbga.TextDataRequestFields.SORT_ORDER] = mbga.TextDataRequest.SortOrder.DESCENDING; // optional
mbga.requestFetchTextData(params, function(response) {
if (response.hadError()) {
// error handling
} else {
var textdatas = response.getData();
textdatas.each(function(textdata) {
var writerId = textdata.getWriterId();
// ...
});
}
});
mbga.newCreateTextDataRequest
<static> Object mbga.newCreateTextDataRequest(opt_params)
テキストデータを新たに作成する為のリクエストを作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| params | Map<mbga.TextDataRequestFields, Object> | – |
返り値
| 型 | 説明 |
|---|---|
| Object | リクエストオブジェクト |
サンプル
var params = {};
var textdata_params = {};
textdata_params[mbga.TextData.Field.DATA] = "Hello, World!"; // required
params[mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME] = "message_board"; // required
params[mbga.TextDataRequestFields.TEXTDATA] = textdata_params; // required
var req = opensocial.newDataRequest();
req.add( mbga.newCreateTextDataRequest(params), "textdata" );
req.send(function(response) {
if (response.hadError()) {
// error
} else {
// 作成したTextDataオブジェクトが返る
var textdata = response.get("textdata").getData();
var data = textdata.getData();
// ...
}
});
mbga.requestCreateTextData
<static> void mbga.requestCreateTextData(params, callback)
テキストデータを新たに作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| params | Map<mbga.TextDataRequestFields, Object> | – |
| callback | function | – |
返り値
なし
サンプル
var params = {};
var textdata_params = {};
textdata_params[mbga.TextData.Field.DATA] = "Hello, World!"; // required
params[mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME] = "message_board"; // required
params[mbga.TextDataRequestFields.TEXTDATA] = textdata_params; // required
mbga.requestCreateTextData(params, function(response) {
if (response.hadError()) {
// error handling
} else {
// 作成したTextDataオブジェクトが返る
var textdata = response.getData();
var data = textdata.getData();
// ...
}
});
mbga.newUpdateTextDataRequest
<static> Object mbga.newUpdateTextDataRequest(opt_params)
既存のテキストデータの内容を更新する為のリクエストを作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| params | Map<mbga.TextDataRequestFields, Object> | – |
返り値
| 型 | 説明 |
|---|---|
| Object | リクエストオブジェクト |
サンプル
var params = {};
var textdata_params = {};
textdata_params[mbga.TextData.Field.DATA] = "Updated!"; // required
params[mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME] = "message_board"; // required
params[mbga.TextDataRequestFields.TEXTDATA_ID] = "4000"; // required
params[mbga.TextDataRequestFields.TEXTDATA] = textdata_params; // required
var req = opensocial.newDataRequest();
req.add( mbga.newUpdateTextDataRequest(params), "textdata" );
req.send(function(response) {
if (response.hadError()) {
// error
} else {
// nullが返る
var nullData = response.get("textdata").getData();
// ...
}
});
mbga.requestUpdateTextData
<static> void mbga.requestUpdateTextData(params, callback)
既存のテキストデータの内容を更新します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| params | Map<mbga.TextDataRequestFields, Object> | – |
| callback | function | – |
返り値
なし
サンプル
var params = {};
var textdata_params = {};
textdata_params[mbga.TextData.Field.DATA] = "Hello, World!"; // required
params[mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME] = "message_board"; // required
params[mbga.TextDataRequestFields.TEXTDATA_ID] = "4000"; // required
params[mbga.TextDataRequestFields.TEXTDATA] = textdata_params; // required
mbga.requestUpdateTextData(params, function(response) {
if (response.hadError()) {
// error handling
} else {
// nullが返る
var nullData = response.getData();
// ...
}
});
mbga.newRemoveTextDataRequest
<static> Object mbga.newRemoveTextDataRequest(opt_params)
既存のテキストデータを削除する為のリクエストを作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| params | Map<mbga.TextDataRequestFields, Object> | – |
返り値
| 型 | 説明 |
|---|---|
| Object | リクエストオブジェクト |
サンプル
var params = {};
var textdata_params = {};
params[mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME] = "message_board"; // required
params[mbga.TextDataRequestFields.TEXTDATA_ID] = "4000"; // required
var req = opensocial.newDataRequest();
req.add( mbga.newRemoveTextDataRequest(params), "textdata" );
req.send(function(response) {
if (response.hadError()) {
// error
} else {
// 削除したTextDataのIDが返る
var id = response.get("textdata").getData();
// ...
}
});
mbga.requestRemoveTextData
<static> void mbga.requestRemoveTextData(params, callback)
既存のテキストデータを削除します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| params | Map<mbga.TextDataRequestFields, Object> | – |
| callback | function | – |
返り値
なし
サンプル
var params = {};
var textdata_params = {};
params[mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME] = "message_board"; // required
params[mbga.TextDataRequestFields.TEXTDATA_ID] = "4000"; // required
mbga.requestRemoveTextData(params, function(response) {
if (response.hadError()) {
// error handling
} else {
// 削除したTextDataのIDが返る
var id = response.getData();
// ...
}
});
mbga.newFriendRequest
<static> Object mbga.newFriendRequest(targetUserId, opt_params)
友達申請を行うためのリクエストを作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| targetUserId | string | – |
| opt_params | Map<mbga.FriendRequestRequestFields, Object> | – |
返り値
| 型 | 説明 |
|---|---|
| mbga.FriendRequest | リクエストオブジェクト |
サンプル
var targetUserId = "sb.mbga.jp:123456";
var opt_params = {};
opt_params[mbga.FriendRequestRequestFields.CONTENT] = "一緒に戦友になって戦おう!";
var friendRequest = mbga.newFriendRequest(targetUserId, opt_params);
mbga.requestFriendRequest
<static> void mbga.requestFriendRequest(friendRequest, opt_callback)
友達申請のリクエストを行います。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| friendRequest | mbga.FriendRequest | – |
| opt_callback | function | – |
返り値
なし
サンプル
mbga.requestFriendRequest(friendRequest, function(response) {
if (response.hadError()) {
/* Something wrong on container side */
}
else {
var friendRequest = response.getData();
if (friendRequest.isSentFriendRequest()) {
/* The viewer sent friend request */
}
else {
/* The viewer didn't friend request */
}
}
} );
更新履歴
- 2013/03/15
- ドキュメント移行