UpdateEntity

Method updates an entity on the server. This operation results in the entity data being completely replaced by the passed in JSON string.

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

Service	Operation
globalEntity	UPDATE

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
jsonEntityData	The entity's data object

Usage

http://localhost:3000

C#

string entityId = "a-entity-id";
int version = 1;
string jsonEntityData = "{\"street\":\"1309 Carling\"}";
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.UpdateEntity(entityId, version, jsonEntityData, successCallback, failureCallback);

C++

const char *entityId = "a-entity-id";
int version = 1;
const char *jsonEntityData = "{\"street\":\"1309 Carling\"}";
_bc->getGlobalEntityService()->updateEntity(entityId, version, jsonEntityData, this);

Objective-C

NSString *entityId = @"a-entity-id";
int version = 1;
NSString *jsonEntityData = @"{\"street\":\"1309 Carling\"}";
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

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

Java

String entityId = "a-entity-id";
int version = 1;
String jsonEntityData = "{\"street\":\"1309 Carling\"}";
this; // implements IServerCallback

_bc.getGlobalEntityService().updateEntity(entityId, version, jsonEntityData, 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 = 1;
var jsonEntityData = {
    "street": "1309 Carling"
};

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

Dart

var  entityId = "a-entity-id";
var  version = 1;
var  jsonEntityData = {
    "street": "1309 Carling"
};

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

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

Cloud Code

var entityId = "a-entity-id";
var version = 1;
var jsonEntityData = {
    "street": "1309 Carling"
};
var globalEntityProxy = bridge.getGlobalEntityServiceProxy();

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

Raw

{
    "service": "globalEntity",
    "operation": "UPDATE",
    "data": {
        "entityId": "the-entity-id",
        "version": 1,
        "data": {
            "street": "1309 Carling"
        }
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "gameId": "123456",
        "entityId": "14281c38-abf6-4ca2-8436-b2bdwas8d5a9a",
        "ownerId": "784cc6c6-4569-4d75-bd10-62dwa8ae0218",
        "entityType": "test",
        "entityIndexedId": "indexTest",
        "version": 1,
        "acl": {
            "other": 1
        },
        "expiresAt": 1449861422588,
        "timeToLive": 34567,
        "createdAt": 1449861388021,
        "updatedAt": 1449861388021
    }
}

Common Error Code

Status Codes

Code	Name	Description
40344	ENTITY_VERSION_MISMATCH	The version passed in does not match the version of the entity on the server