UpdateSummaryFriendData

Updates the "friend summary data" associated with the logged in user.

Some operations will return this summary data. For instance the social leaderboards will return the player's score in the leaderboard along with the friend summary data. Generally this data is used to provide a quick overview of the user without requiring a separate API call to read their public stats or entity data.

The friend summary data can also be requested with the GetSummaryDataForProfileId api call.

Service	Operation
playerState	UPDATE_SUMMARY

Method Parameters

Parameter	Description
summaryFriendData	A JSON string defining the summary data. For example { "xp":123, "level":12, "highScore":45123 }

Usage

http://localhost:3000

C#

string summaryFriendData = "{\"xp\":12,\"attributeName\":\"value\"}";
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.PlayerStateService.UpdateSummaryFriendData(summaryFriendData, successCallback, failureCallback);

C++

const char *summaryFriendData = "{\"xp\":12,\"attributeName\":\"value\"}";
_bc->getPlayerStateService()->updateSummaryFriendData(summaryFriendData, this);

Objective-C

NSString *summaryFriendData = @"{\"xp\":12,\"attributeName\":\"value\"}";
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc playerStateService] updateSummaryFriendData:summaryFriendData
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String summaryFriendData = "{\"xp\":12,\"attributeName\":\"value\"}";
this; // implements IServerCallback

_bc.getPlayerStateService().updateSummaryFriendData(summaryFriendData, 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 summaryFriendData = {
    "xp": 12,
    "attributeName": "value"
};

_bc.playerState.updateSummaryFriendData(summaryFriendData, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  summaryFriendData = {
    "xp": 12,
    "attributeName": "value"
};

ServerResponse result = await _bc.playerStateService.updateSummaryFriendData(summaryFriendData:summaryFriendData);

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

Cloud Code

var summaryFriendData = {
    "xp": 12,
    "attributeName": "value"
};
var playerStateProxy = bridge.getPlayerStateServiceProxy();

var postResult = playerStateProxy.updateSummaryFriendData(summaryFriendData);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "playerState",
    "operation": "UPDATE_SUMMARY",
    "data": {
        "summaryFriendData": {
            "xp": 12,
            "attributeName": "value"
        }
    }
}

JSON Response

{
    "status":200,
    "data": null
}