UpdateEntityFields

tip

This method is not sharding safe - and thus is not recommended for custom entities that you may want to shard for greater performance and scalability in the future. Consider using UpdateEntityFieldsSharded() version of this method instead.

Used to update only a specific set of fields with the custom data section of the custom entity object.

The outer "data" portion of the field name is implied, and should not be included.

fieldsJson example:

{
  "age": 30,
  "homeAddress": {
    "street": Breakwater Street",
    "number": "11",
    "city": "Souris",
    "state": "PEI",
    "country": "CA",
    "phone": "555-555-1234"
  },
  "workAddress.phone": "555-555-5555"
}

For the above example:

• the data.age field will be set to 30
• the data.homeAddress field will be set to the full JSON address provided
• just the phone sub-field of the data.workAddress object will be set to "555-555-5555"

Service	Operation
customEntity	UPDATE_ENTITY_FIELDS

Method Parameters

Parameter	Description
entityType	The type of custom entity being updated.
entityId	The id of custom entity being updated.
version	Version of the custom entity being updated.
fieldsJson	Specific fields, as JSON, to set within entity's custom data.

Usage

http://localhost:3000

C#

string entityType = "athletes";
string entityId = "aaaa-bbbb-cccc-dddd";
int version = 1;
string fieldsJson = "{\"goals\":3,\"assists\":5}";
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.UpdateEntityFields(entityType, entityId, version, fieldsJson, successCallback, failureCallback);

C++

const char *entityType = "athletes";
const char *entityId = "aaaa-bbbb-cccc-dddd";
int version = 1;
const char *fieldsJson = "{\"goals\":3,\"assists\":5}";
_bc->getCustomEntityService()->updateEntityFields(entityType, entityId, version, fieldsJson, this);

Objective-C

NSString *entityType = @"athletes";
NSString *entityId = @"aaaa-bbbb-cccc-dddd";
int version = 1;
NSString *fieldsJson = "{\"goals\":3,\"assists\":5}";
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

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

Java

String entityType = "athletes";
String entityId = "aaaa-bbbb-cccc-dddd";
int version = 1;
String fieldsJson = "{\"goals\":3,\"assists\":5}";
this; // implements IServerCallback

_bc.getCustomEntityService().updateEntityFields(entityType, entityId, version, fieldsJson, 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;
var fieldsJson = {
  "goals": 3,
  "assists": 5
};

_bc.customEntity.updateEntityFields(entityType, entityId, version, fieldsJson, 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;
var  fieldsJson = {
  "goals": 3,
  "assists": 5
};

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

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 fieldsJson = {
  "goals": 3,
  "assists": 5
};
var customEntityProxy = bridge.getCustomEntityServiceProxy();

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

Raw

{
    "service": "customEntity",
    "operation": "UPDATE_ENTITY_FIELDS",
    "data": {
        "entityType": "athletes",
        "entityId": "aaaa-bbbb-cccc-dddd",
        "version": 1,
        "fieldsJson": {
            "goals": 3,
            "assists": 5
        }
    }
}

JSON Response

{
  "status": 200,
  "data": {
    "entityId": "1497cc7e-66cb-4682-xxxx-c755523369a8",
    "version": 2,
    "acl": {
      "other": 1
    },
    "ownerId": null,
    "expiresAt": null,
    "timeToLive": null,
    "createdAt": 1573540122600,
    "updatedAt": 1573540445332
  }
}