Skip to main content

mbga

Method​

mbga.newFetchBlackListRequest​

<static> Object mbga.newFetchBlackListRequest(idSpec, opt_params)

Creates a request for acquiring a list of blacklisted users.

Parameter​
NameTypeDescription
idSpecopensocial.IdSpec–
opt_paramsMap<mbga.BlackListRequestFields, Object>–
Return value​
TypeDescription
ObjectRequest object
Sample​
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); // Only ALL is allowed.
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)

Acquires a list of blacklisted users.

Parameter​
NameTypeDescription
idSpecopensocial.IdSpec–
opt_paramsMap<mbga.BlackListRequestFields, Object>–
callbackfunction–
Return value​

None

Sample​
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)

Generates a request for investigating whether or not the passed string contains NGWords.

Parameter​
NameTypeDescription
dataStringThe string to be investigated for containing NGWords
Return value​
TypeDescription
ObjectRequest object
Sample​
var text = 'Words such as “kill” may not be used on message boards, etc.';
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)

Investigates whether or not the passed string contains NGWords.

Parameter​
NameTypeDescription
dataStringThe string to be investigated for containing NGWords
callbackfunction–
Return value​

None

Sample​
var text = 'Words such as "kill" may not be used on message boards, etc.';
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 )

Posts diary entries.

Parameter​
NameTypeDescription
paramsobjectParameters for diary entries to be posted.
Return value​

None

Sample​
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] = 'Pirate ship destroyed!'; // optional
params[mbga.Diary.Field.CONTENT] = 'A commemorative photo of the destroyed pirate ship.'; // optional
params[mbga.Diary.Field.MEDIA_ITEMS] = [ mediaItem ]; // optional

var diary = mbga.newCreateDiary(params);

mbga.requestCreateDiary​

void mbga.requestCreateDiary( diary, callback )

Posts diary entries.

Parameter​
NameTypeDescription
diarymbga.DiaryDiary object
callbackfunctionReceives callbacks.
Return value​

None

Sample​
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, 'Pirate ship destroyed!' ); // optional
diary.setField( mbga.Diary.Field.CONTENT, 'A commemorative photo of the destroyed pirate ship.' ); // 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)

Creates a request for acquiring an avatar image.

Parameter​
NameTypeDescription
idSpecopensocial.IdSpec–
opt_paramsMap<mbga.AvatarRequestFields, Object>–
Return value​
TypeDescription
ObjectRequest object
Sample​
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); // Only SELF is allowed.
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)

Acquires an avatar image.

Parameter​
NameTypeDescription
idSpecopensocial.IdSpec–
opt_paramsMap<mbga.AvatarRequestFields, Object>–
callbackfunction–
Return value​

None

Sample​
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)

Creates a request for acquiring the text data

Parameter​
NameTypeDescription
paramsMap<mbga.TextDataRequestFields, Object>–
Return value​
TypeDescription
ObjectRequest object
Sample​
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)

Acquires The text data.

Parameter​
NameTypeDescription
paramsMap<mbga.TextDataRequestFields, Object>–
callbackfunction–
Return value​

None

Sample​
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)

This creates a request for creating new TextData.

Parameter​
NameTypeDescription
paramsMap<mbga.TextDataRequestFields, Object>–
Return value​
TypeDescription
ObjectRequest object
Sample​
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 {
// The created TextData object is returned.
var textdata = response.get("textdata").getData();
var data = textdata.getData();
// ...
}
});

mbga.requestCreateTextData​

<static> void mbga.requestCreateTextData(params, callback)

This creates new TextData.

Parameter​
NameTypeDescription
paramsMap<mbga.TextDataRequestFields, Object>–
callbackfunction–
Return value​

None

Sample​
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 {
// The created TextData object is returned.
var textdata = response.getData();
var data = textdata.getData();
// ...
}
});

mbga.newUpdateTextDataRequest​

<static> Object mbga.newUpdateTextDataRequest(opt_params)

This creates a request for updating the content of existing TextData.

Parameter​
NameTypeDescription
paramsMap<mbga.TextDataRequestFields, Object>–
Return value​
TypeDescription
ObjectRequest object
Sample​
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 is returned.
var nullData = response.get("textdata").getData();
// ...
}
});

mbga.requestUpdateTextData​

<static> void mbga.requestUpdateTextData(params, callback)

This updates the content of existing TextData.

Parameter​
NameTypeDescription
paramsMap<mbga.TextDataRequestFields, Object>–
callbackfunction–
Return value​

None

Sample​
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 is returned.
var nullData = response.getData();
// ...
}
});

mbga.newRemoveTextDataRequest​

<static> Object mbga.newRemoveTextDataRequest(opt_params)

This creates a request for deleting the content of existing TextData.

Parameter​
NameTypeDescription
paramsMap–
Return value​
TypeDescription
ObjectRequest object
Sample​
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 {
// The ID of deleted TextData is returned.
var id = response.get("textdata").getData();
// ...
}
});

mbga.requestRemoveTextData​

<static> void mbga.requestRemoveTextData(params, callback)

This deletes the existing TextData.

Parameter​
NameTypeDescription
paramsMap<mbga.TextDataRequestFields, Object>–
callbackfunction–
Return value​

None

Sample​
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 {
// The ID of deleted TextData is returned.
var id = response.getData();
// ...
}
});

Revision History​

  • 12/2010
    • Initial Release.