DeleteEntity

Deletes the specified custom entity on the server.

Service	Operation
customEntity	DELETE_ENTITY

Method Parameters

Parameter	Description
entityType	The type of custom entity being deleted.
entityId	The id of custom entity being deleted.
version	Version of the custom entity being deleted.

Usage

http://localhost:3000

C#

string entityType = "athletes";
string entityId = "aaaa-bbbb-cccc-dddd";
int version = 1;
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.CustomEntityService.DeleteEntity(entityType, entityId, version, successCallback, failureCallback);

C++

const char *entityType = "athletes";
const char *entityId = "aaaa-bbbb-cccc-dddd";
int version = 1;
_bc->getCustomEntityService()->deleteEntity(entityType, entityId, version, this);

Objective-C

NSString *entityType = @"athletes";
NSString *entityId = @"aaaa-bbbb-cccc-dddd";
int version = 1;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc customEntityService] deleteEntity:entityType
                   entityId:entityId
                    version:version
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String entityType = "athletes";
String entityId = "aaaa-bbbb-cccc-dddd";
int version = 1;
this; // implements IServerCallback

_bc.getCustomEntityService().deleteEntity(entityType, entityId, version, 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 entityType = "athletes";
var entityId = "aaaa-bbbb-cccc-dddd";
var version = 1;

_bc.customEntity.deleteEntity(entityType, entityId, version, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  entityType = "athletes";
var  entityId = "aaaa-bbbb-cccc-dddd";
var  version = 1;

ServerResponse result = await _bc.customEntityService.deleteEntity(entityType:entityType, entityId:entityId, version:version);

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

Cloud Code

var entityType = "athletes";
var entityId = "aaaa-bbbb-cccc-dddd";
var version = 1;
var customEntityProxy = bridge.getCustomEntityServiceProxy();

var postResult = customEntityProxy.deleteEntity(entityType, entityId, version);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "customEntity",
    "operation": "DELETE_ENTITY",
    "data": {
        "entityType": "athletes",
        "entityId": "aaaa-bbbb-cccc-dddd",
        "version": 1
    }
}

JSON Response

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