ReadAchievements

Read all of the achievements defined for the game.

Service	Operation
gamification	READ_ACHIEVEMENTS

Method Parameters

Parameter	Description
includeMetaData	Whether to return meta data as well

Usage

http://localhost:3000

C#

bool includeMetaData = false;
SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("Success | {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("Failed | {0}  {1}  {2}", status, code, error));
};

_bc.GamificationService.ReadAchievements(includeMetaData, successCallback, failureCallback);

C++

bool includeMetaData = false;
_bc->getGamificationService()->readAchievements(includeMetaData, this);

Objective-C

bool includeMetaData = false;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc gamificationService] readAchievements:includeMetaData
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

boolean includeMetaData = false;
this; // implements IServerCallback

_bc.getGamificationService().readAchievements(includeMetaData, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var includeMetaData = false;

_bc.gamification.readAchievements(includeMetaData, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  includeMetaData = false;

ServerResponse result = await _bc.gamificationService.readAchievements(includeMetaData:includeMetaData);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Cloud Code

var includeMetaData = false;
var gamificationProxy = bridge.getGamificationServiceProxy();

var postResult = gamificationProxy.readAchievements(includeMetaData);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "gamification",
    "operation": "READ_ACHIEVEMENTS",
    "data": {
        "includeMetaData": false
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "achievements": [{
            "fbEnabled": false,
            "imageUrl": "https://api.braincloudservers.com/s3/portal/g/123456/metadata/achievements/testAchievement01.png",
            "status": "NOT_AWARDED",
            "gameId": "20001",
            "steamEnabled": false,
            "extraData": null,
            "achievementId": "testAchievement01",
            "invisibleUntilEarned": false,
            "steamAchievementId": null,
            "id": "testAchievement01",
            "appleEnabled": false,
            "title": "Test Achievement 1",
            "fbGamePoints": null,
            "description": "Test description.",
            "appleAchievementId": null
        }]
    }
}