AbandonMatchWithSummaryData

Marks the given match as abandoned and sets the matchState to EXPIRED.

caution

Only a match whose current status is NOT_STARTED, PENDING or EXPIRED can be abandoned (status set to EXPIRED)

Service	Operation
asyncMatch	ABANDON_MATCH_WITH_SUMMARY_DATA

Method Parameters

Parameter	Description
ownerId	The match owner id.
matchId	The match id.
pushContent	Optional push notification message to send to the other party. Refer to the Push Notification functions for the syntax required.
summary	Optional JSON object defining what the other player will see as a summary of the game when listing their games.

Usage

http://localhost:3000

C#

string ownerId = "the-owner-id";
string matchId = "the-match-id";
string pushContent = "An async-match has been abandoned!";
string summary = "{\"abandonBy\":{\"display\":\"Match abandoned by John Doe.\",\"player\":2,\"reason\":\"forfeit\"}}";
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.AsyncMatchService.AbandonMatchWithSummaryData(ownerId, matchId, pushContent, summary, successCallback, failureCallback);

C++

const char *ownerId = "the-owner-id";
const char *matchId = "the-match-id";
const char *pushContent = "An async-match has been abandoned!";
const char *summary = "{\"abandonBy\":{\"display\":\"Match abandoned by John Doe.\",\"player\":2,\"reason\":\"forfeit\"}}";
_bc->getAsyncMatchService()->abandonMatchWithSummaryData(ownerId, matchId, pushContent, summary, this);

Objective-C

NSString *ownerId = @"the-owner-id";
NSString *matchId = @"the-match-id";
NSString *pushContent = @"An async-match has been abandoned!";
NSString *summary = "{\"abandonBy\":{\"display\":\"Match abandoned by John Doe.\",\"player\":2,\"reason\":\"forfeit\"}}";
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc asyncMatchService] abandonMatchWithSummaryData:ownerId
                    matchId:matchId
                pushContent:pushContent
                    summary:summary
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String ownerId = "the-owner-id";
String matchId = "the-match-id";
String pushContent = "An async-match has been abandoned!";
String summary = "{\"abandonBy\":{\"display\":\"Match abandoned by John Doe.\",\"player\":2,\"reason\":\"forfeit\"}}";
this; // implements IServerCallback

_bc.getAsyncMatchService().abandonMatchWithSummaryData(ownerId, matchId, pushContent, summary, 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 ownerId = "the-owner-id";
var matchId = "the-match-id";
var pushContent = "An async-match has been abandoned!";
var summary = {
  "abandonBy": {
    "display": "Match abandoned by John Doe.",
    "player": 2,
    "reason": "forfeit"
  }
};

_bc.asyncMatch.abandonMatchWithSummaryData(ownerId, matchId, pushContent, summary, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  ownerId = "the-owner-id";
var  matchId = "the-match-id";
var  pushContent = "An async-match has been abandoned!";
var  summary = {
  "abandonBy": {
    "display": "Match abandoned by John Doe.",
    "player": 2,
    "reason": "forfeit"
  }
};

ServerResponse result = await _bc.asyncMatchService.abandonMatchWithSummaryData(ownerId:ownerId, matchId:matchId, pushContent:pushContent, summary:summary);

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

Cloud Code

var ownerId = "the-owner-id";
var matchId = "the-match-id";
var pushContent = "An async-match has been abandoned!";
var summary = {
  "abandonBy": {
    "display": "Match abandoned by John Doe.",
    "player": 2,
    "reason": "forfeit"
  }
};
var asyncMatchProxy = bridge.getAsyncMatchServiceProxy();

var postResult = asyncMatchProxy.abandonMatchWithSummaryData(ownerId, matchId, pushContent, summary);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "asyncMatch",
    "operation": "ABANDON_MATCH_WITH_SUMMARY_DATA",
    "data": {
        "ownerId": "the-owner-id",
        "matchId": "the-match-id",
        "pushContent": "An async-match has been abandoned!",
        "summary": {
            "abandonBy": {
                "display": "Match abandoned by John Doe.",
                "player": 2,
                "reason": "forfeit"
            }
        }
    }
}

JSON Response

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