DeleteEntity

Method deletes the given entity on the server.

This method is affected by versioning. See the versioning documentation for more information.

Service	Operation
globalEntity	DELETE

Method Parameters

Parameter	Description
entityId	The id of the entity to update
version	The version of the entity to update. Use -1 to indicate the newest version

Usage

http://localhost:3000

C#

string entityId = "a-entity-id";
int version = 2;
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.GlobalEntityService.DeleteEntity(entityId, version, successCallback, failureCallback);

C++

const char *entityId = "a-entity-id";
int version = 2;

_bc->getGlobalEntityService()->deleteEntity(entityId, version, this);

Obj-C

NSString *entityId = @"a-entity-id";
int version = 2;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

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

Java

String entityId = "a-entity-id";
int version = 2;
this; // implements IServerCallback

_bc.getGlobalEntityService().deleteEntity(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 entityId = "a-entity-id";
var version = 2;

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

Dart

var  entityId = "a-entity-id";
var  version = 2;

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

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

Roblox

local entityId = "a-entity-id"
local version = 2

local callback = function(result)
    if result.statusCode == 200 then
        print("Success")
    else
        print("Failed | " .. tostring(result.status))
    end
end

_bc:getGlobalEntityService():deleteEntity(entityId, version, callback)

GDScript

var entity_id = "a-entity-id"
var version = 2

var result = await _bc.global_entity_service.delete_entity(entity_id, version)

if result.status == 200:
	print("Success")
else:
	print("Failed: %s" % result.status_message)

Cloud Code

var entityId = "a-entity-id";
var version = 2;
var globalEntityProxy = bridge.getGlobalEntityServiceProxy();

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

Raw

{
    "service": "globalEntity",
    "operation": "DELETE",
    "data": {
        "entityId": "the-entity-id",
        "version": 2
    }
}

JSON Response

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

Common Error Code

Status Codes

Code	Name	Description
40344	ENTITY_VERSION_MISMATCH	The version parameter does not match the current version on the server