Request current user's ID from the platform and return to callback function.
Function callback - The function to call once the request has been processed. The function will be passed three parameters, int returnCode, String returnMessage and String userID. If there was an error, userID returns as NULL.
None
Integer returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
String userID - A string of user ID. If there was an error, userID returns null.
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqinit);
function wqinit()
{
wqapi.getSelfID(function(returnCode,returnMessage,userID)
{
var output = document.getElementById('output');
output.innerHTML= 'returnCode ' + returnCode +
' returnMessage ' + returnMessage + ' userID ' + userID + '\n';
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
}else
{
//Fail to get self ID
}
});
}
Request a list of friends ID from the platform and return to callback function.
Boolean hasApp - When true, filter users who installed the App.
Function callback - The function to call once the request has been processed. The function will be passed three parameters, int returnCode, String returnMessage and Array.<String> userIDList
None
Integer returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
Array.<String> userIDList - A List of users' ID.
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqinit);
function wqinit()
{
var hasApp = false;
wqapi.getFriendsID(hasApp,function(returnCode,returnMessage,userIDList)
{
var output = document.getElementById('output');
output.innerHTML= 'returnCode ' + returnCode +
' returnMessage ' + returnMessage + ' userIDList ' + userIDList + '\n';
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
}else
{
//Fail to get Friends
}
});
}
Request the platform to get users' profile data.
Array.<String> userIDList - List of user ID, represented users to be retrieved data.
Array.<WizQAPI.User.Fields> params - List of field to be retrieved.
Function callback - The function to call once the request has been processed. The function will be passed three parameters, int returnCode, String returnMessage and Map.<String, Map.< WizQAPI.User.Fields, Object>> usersProfile.
None
Integer returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
Array.<String, Array.< WizQAPI.User.Fields, Object>> usersProfile - A collection of user profile. Each object maps with user ID; inside that object, each value maps with WizQAPI.User.Fields
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqInit);
function wqInit()
{
var userList = new Array();
userList.push('123');
userList.push('125');
getUsersProfile(userIDListArray);
}
function getUsersProfile(userIDListArray)
{
var params = new Array();
params.push(WizQAPI.User.Fields.FIELD_HAS_APP);
params.push(WizQAPI.User.Fields.FIELD_DISPLAY_NAME);
params.push(WizQAPI.User.Fields.FIELD_ID);
params.push(WizQAPI.User.Fields.FIELD_PROFILE_IMAGE_URL);
params.push(WizQAPI.User.Fields.FIELD_PROFILE_URL);
params.push(WizQAPI.User.Fields.FIELD_AGE);
params.push(WizQAPI.User.Fields.FIELD_DATE_OF_BIRTH);
params.push(WizQAPI.User.Fields.FIELD_GENDER);
wqapi.getUsersProfile(userIDListArray,params,function(returnCode, returnMessage, usersProfile)
{
var output = document.getElementById('output');
output.innerHTML= 'returnCode ' + returnCode + ' returnMessage ' + returnMessage + '\n';
if(returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
for(var key in usersProfile)
{
var user = usersProfile[key];
var hasApp = user[WizQAPI.User.Fields.FIELD_HAS_APP];
var displayName = user[WizQAPI.User.Fields.FIELD_DISPLAY_NAME];
var userID = user[WizQAPI.User.Fields.FIELD_ID];
var profileImageURL = user[WizQAPI.User.Fields.FIELD_PROFILE_IMAGE_URL];
var profileURL = user[WizQAPI.User.Fields.FIELD_PROFILE_URL];
var age = user[WizQAPI.User.Fields.FIELD_AGE];
var dateOfBirth = user[WizQAPI.User.Fields.FIELD_DATE_OF_BIRTH];
var gender = user[WizQAPI.User.Fields.FIELD_GENDER];
output.innerHTML += "hasApp : " + hasApp + "<br/>";
output.innerHTML += "displayName : " + displayName + "<br/>";
output.innerHTML += "userID : " + userID + "<br/>";
output.innerHTML += "profileImageURL : " + profileImageURL + "<br/>";
output.innerHTML += "profileURL : " + profileURL + "<br/>";
output.innerHTML += "age : " + age + "<br/>";
output.innerHTML += "dateOfBirth : " + dateOfBirth + "<br/>";
output.innerHTML += "gender : " + gender + "<br/>";
output.innerHTML += "==============================================<br/>";
}
}
else
{
//Fail to get user profile
}
});
}
Request to post a story to user's page.
String title - The title of the feed
String opt_body - The body of the feed
Array.<WizQAPI.Media> opt_media - A list of media item. Represents images to show in the feed and the maximum of the array length is 3.
WizQAPI.Feed.Priority opt_priority - The priority for the request
String opt_link - The URL that represents the feed
Function opt_callback - A function to call once the request has been processed. The function will be passed two parameters, int returnCode and String returnMessage.
None
int returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
function postFeed()
{
var title = "Feed Title";
var body = "Feed Body";
var mediaList = new Array();
mediaList.push(WizQAPI.Media.createEmptyMedia());
mediaList.push(WizQAPI.Media.createPNGMedia('http://www.wizq.com/images/logo.png'));
var url = "";
wqapi.postFeed(title,body,mediaList,WizQAPI.Feed.Priority.HIGH,url,function(returnCode,returnMessage)
{
var output = document.getElementById('output');
output.innerHTML= 'returnCode ' + returnCode + ' returnMessage ' + returnMessage + '\n';
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
}else
{
//failure
}
});
}
Request the platform to share the App with friends.
Function callback - The function to call once the request has been processed. The function will be passed three parameters, int returnCode, String returnMessage and Array.<String> userIDList.
None
int returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
Array.<String> userIDList - A list of selected users' ID. If there was an error, userIDList returns an empty array.
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqinit);
function wqinit()
{
wqapi.inviteFriends(function(returnCode,returnMessage,userIDList)
{
var output = document.getElementById('output');
output.innerHTML= 'returnCode ' + returnCode +
' returnMessage ' + returnMessage + ' userIDList ' + userIDList + '\n';
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
}else
{
//failure
}
});
}
Get the JSON string from appParams in URL and convert it into Object.
None
Object - The converted value of appParams.
None
URL:
http://yahoo-mbga.jp/game/12001234/play?appParams={"id": "abc1234", "name": "wizQ"}
JS:
var data = wqapi.getAppParam();
alert(data.id); //abc1234
alert(data.name); //wizQ
Validate user input if it passes the platform policy.
String input - The user input
Function opt_callback - A function to call once the request has been processed. The function will be passed three parameters, int returnCode, String returnMessage and Boolean result.
None
int returnCode - The integer identifies the status of the function call
String returnMessage - The message decribes the function status
Boolean result - When true, the user input passes the policy
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqInit);
function wqInit()
{
var input = '殺す';
wqapi.validateUserInput(input,function(returnCode, returnMessage , result)
{
output.innerHTML= 'returnCode ' + returnCode + ' returnMessage ' + returnMessage + ' result ' + result+ '\n';
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
if(result == true)
{
//valid input
}else
{
//invalid input
}
}else
{
//failure
}
});
};
Send a proxy request
String url - URL to be requested
WizQAPI.RequestMethod method - The request method
String requestParams - Request parameters in key-value pair format, for example, id=123&name=name&status="You%26Me". All the values must be escaped with encodeURIComponent(). null for no parameters.
Function callback - The function to call once the request has been processed. The function will be passed three parameters, int returnCode, String returnMessage and String content.
None
Integer returnCode - The integer identifies the status of the function call
String returnMessage - The message decribes the function status
String response - The response of the request.
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqInit);
function wqInit()
{
var url = "https://api.dev.wizq.net/makeRequest.php";
var method = WizQAPI.RequestMethod.GET;
var requestParams = "content_id=1&page=2&name=You%26Me";
wqapi.makeRequest(url, method, requestParams, function(returnCode, returnMessage, response)
{
var output = document.getElementById('output');
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
output.innerHTML = response;
}else
{
//failure
output.innerHTML = 'Fail to get content from my server!';
}
});
}
Request to begin a payment transaction from the platform and return to callback function.
Integer skuID - A non-null and non-empty stock-keeping unit uniquely identifies a product
Integer skuQuantity - An unsigned integer (greater than 0) specifies the purchase quantity of the product
Integer skuUnitPrice - An unsigned integer (greater than 0) specifies the price of the product
String skuName - A non-null and non-empty string specifies the name of the product
String skuImageURL - A non-null and non-empty string specifies the image of the product
String handlePaymentURL - A non-null and non-empty string specifies the location of the payment handler (will be provided by WizQ)
Function callback - A function to call once the request has been processed
None
Integer returnCode - The integer identifies the status of the function call
String returnMessage - The message decribes the function status
Some platform may trigger a page reload, success or failure cannot be determined by the callback return code
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqinit);
function wqinit()
{
var skuID = 12345678;
var skuQuantity = 1;
var skuUnitPrice = 210;
var skuName = "Clothes";
var skuImageURL = "http://www.wizq.com/images/logo.png";
var handlePaymentURL = wizqConfig.handlePaymentURL;
wqapi.requestPayment(skuID, skuQuantity, skuUnitPrice, skuName, skuImageURL, handlePaymentURL, function(returnCode, returnMessage)
{
var output = document.getElementById('output');
output.innerHTML= 'returnCode ' + returnCode + ' returnMessage ' + returnMessage + '\n';
if (returnCode == WizQAPI.ReturnCode.PAYMENT_REQUEST_SENT.code)
{
// request sent, success or failure cannot be determined
}
else if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
// success
}
else
{
// fail
}
});
}
Reset the height of the canvas.
None
None
None
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqinit);
function wqinit()
{
wqapi.resetHeight();
}
Submit user score to leaderboard.
String leaderboardID - Identifier of the leaderboard , maximum length 20 characters
String score - User score, accept range 0-9007199254740992 represented as string
Boolean forceUpdate - Force replace the highest score
Function callback - The function to call once the request has been processed
None
Integer returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqInit);
function wqInit()
{
var leaderBoardID = 'topScore';
var score = '12000'
var forceUpdate = false;
wqapi.submitScore(leaderBoardID,score,false,function(returnCode,returnMessage)
{
var output = document.getElementById('output');
output.innerHTML= 'returnCode ' + returnCode + ' returnMessage ' + returnMessage + '\n';
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
}else
{
//Fail to submit
}
});
}
Get user ranking from the leaderboard.
String leaderboardID - Identifier of the leaderboard , maximum length 20 characters
String requestUserID - Identifier of the target user
Function callback - The function to call once the request has been processed
None
Integer returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
Integer rank - The rank of the requested user.
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqInit);
function wqInit()
{
var leaderBoardID = 'topScore';
var requestUserID = 'sb.yahoo-mbga.jp:23371';
wqapi.getUserRank(leaderBoardID,requestUserID,function(returnCode,returnMessage,rank)
{
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
alert('returnCode : ' + returnCode + ' returnMessage : ' + returnMessage + ' rank ' + rank);
}else
{
//Fail to get my rank
}
});
}
Get current user top score in the leaderboard.
String leaderboardID - Identifier of the leaderboard , maximum length 20 characters
Function callback - The function to call once the request has been processed
None
Integer returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
String score - The top score of the current user represented as string.
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqInit);
function wqInit()
{
var leaderBoardID = 'topScore';
wqapi.getSelfTopScore(leaderBoardID,function(returnCode,returnMessage,score)
{
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
alert('returnCode : ' + returnCode + ' returnMessage : ' + returnMessage + ' score ' + score);
}else
{
//Fail to get my score
}
});
}
Get user top score from the leaderboard.
String leaderboardID - Identifier of the leaderboard , maximum length 20 characters
String requestUserID - Identifier of the target user
Function callback - The function to call once the request has been processed
None
Integer returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
String score - The top score of the current user represented as string.
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqInit);
function wqInit()
{
var leaderBoardID = 'topScore';
var requestUserID = 'sb.yahoo-mbga.jp:23371';
wqapi.getUserTopScore(leaderBoardID,requestUserID,function(returnCode,returnMessage,score)
{
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
alert('returnCode : ' + returnCode + ' returnMessage : ' + returnMessage + ' score ' + score);
}else
{
//Fail to get my score
}
});
}
Get user top score from the leaderboard.
String leaderboardID - Identifier of the leaderboard , maximum length 20 characters
Integer startingRank - A positive integer specifies the starting rank to be retrieved.
Integer count - The numbers of records to be retrieved.
Function callback - The function to call once the request has been processed
None
Integer returnCode - The integer identifies the status of the function call.
String returnMessage - The message describes the function status.
Array scoreList - Array of the score info object. The score info object contains 3 properties, rank Integer , userID String and score String.
var wizqBootStrap = new WizQBootStrap();
wizqBootStrap.init(wizqConfig);
wizqBootStrap.registerOnLoadHandler(wqInit);
function wqInit()
{
var leaderBoardID = 'topScore';
var startingRank = 1;
var count = 50;
wqapi.getScores(leaderBoardID,startingRank,count,function(returnCode,returnMessage,scoreList)
{
if (returnCode == WizQAPI.ReturnCode.SUCCESS.code)
{
//success
var scoreInfoMsg = "";
for(var i=0;i<scoreList.length;i++)
{
var scoreInfo = scoreList[i];
scoreInfoMsg += "userID : " + scoreInfo.userID + " rank : " + scoreInfo.rank + " score : " + scoreInfo.score + "\n";
}
alert('returnCode : ' + returnCode + ' returnMessage : ' + returnMessage + ' scoreList' + scoreInfoMsg);
}else
{
//Fail to get score list
}
});
}