GetSharedEntitiesListForProfileId

Method gets list of shared entities for the specified user based on type and/or where clause.

Fields available for use in the 'where' clause are:

• entityType
• createdAt
• updatedAt

Along with all custom data (using data.). For more information on the query syntax see here.

Service	Operation
entity	READ_SHARED_ENTITIES_LIST

Method Parameters

Parameter	Description
targetProfileId	The profile ID to retrieve shared entities for
whereJson	Mongo style query string
orderByJson	Specifies the order in which the query returns matching documents. The sort parameter consists of a field followed by an ascending(1)/descending flag(-1). eg. { "name" : 1} sorts by name in ascending order
maxReturn	The maximum number of entities to return

Usage

http://localhost:3000

C#

string targetProfileId = "profile1";
string whereJson = "{\"entityType\":\"address\",\"data.street\":\"1309 Carling\"}";
string orderByJson = "{\"data.street\":1}";
int maxReturn = 50;
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.EntityService.GetSharedEntitiesListForProfileId(targetProfileId, whereJson, orderByJson, maxReturn, successCallback, failureCallback);

C++

const char *targetProfileId = "profile1";
const char *whereJson = "{\"entityType\":\"address\",\"data.street\":\"1309 Carling\"}";
const char *orderByJson = "{\"data.street\":1}";
int maxReturn = 50;
_bc->getEntityService()->getSharedEntitiesListForProfileId(targetProfileId, whereJson, orderByJson, maxReturn, this);

Obj-C

NSString *targetProfileId = @"profile1";
NSString *whereJson = @"{\"entityType\":\"address\",\"data.street\":\"1309 Carling\"}";
NSString *orderByJson = @"{\"data.street\":1}";
int maxReturn = 50;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc entityService] getSharedEntitiesListForProfileId:targetProfileId
                  whereJson:whereJson
                orderByJson:orderByJson
                  maxReturn:maxReturn
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String targetProfileId = "profile1";
String whereJson = "{\"entityType\":\"address\",\"data.street\":\"1309 Carling\"}";
String orderByJson = "{\"data.street\":1}";
int maxReturn = 50;
this; // implements IServerCallback

_bc.getEntityService().getSharedEntitiesListForProfileId(targetProfileId, whereJson, orderByJson, maxReturn, 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 targetProfileId = "profile1";
var whereJson = {
    "entityType": "address",
    "data.street": "1309 Carling"
};
var orderByJson = {
    "data.street": 1
};
var maxReturn = 50;

_bc.entity.getSharedEntitiesListForProfileId(targetProfileId, whereJson, orderByJson, maxReturn, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  targetProfileId = "profile1";
var  whereJson = {
    "entityType": "address",
    "data.street": "1309 Carling"
};
var  orderByJson = {
    "data.street": 1
};
var  maxReturn = 50;

ServerResponse result = await _bc.entityService.getSharedEntitiesListForProfileId(targetProfileId:targetProfileId, whereJson:whereJson, orderByJson:orderByJson, maxReturn:maxReturn);

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

Roblox

local targetProfileId = "profile1"
local whereJson = {
    entityType = "address",
    ["data.street"] = "1309 Carling"
}
local orderByJson = {
    ["data.street"] = 1
}
local maxReturn = 50

local callback = function(success, response)
    if success then
        print("Success")
    else
        print("Failed | " .. tostring(response.status_message))
    end
end

_bc.entity:getSharedEntitiesListForProfileId(targetProfileId, whereJson, orderByJson, maxReturn, callback)

GDScript

var target_profile_id = "profile1"
var where_json = {
    "entityType": "address",
    "data.street": "1309 Carling"
}
var order_by_json = {
    "data.street": 1
}
var max_return = 50

var result = await _bc.entity_service.get_shared_entities_list_for_profile_id(target_profile_id, where_json, order_by_json, max_return)

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

Lua

local profileId = "profile1"
local where = { entityType = "address", ["data.street"] = "1309 Carling" }
local orderBy = { ["data.street"] = 1 }
local maxReturn = 50

local callback = function(success, response)
    if success then
        print("Success")
    else
        print("Failed | " .. tostring(response.status_message))
    end
end

_bc.entity:getSharedEntitiesListForProfileId(profileId, where, orderBy, maxReturn, callback)

Cloud Code

var targetProfileId = "profile1";
var whereJson = {
    "entityType": "address",
    "data.street": "1309 Carling"
};
var orderByJson = {
    "data.street": 1
};
var maxReturn = 50;
var entityProxy = bridge.getEntityServiceProxy();

var postResult = entityProxy.getSharedEntitiesListForProfileId(targetProfileId, whereJson, orderByJson, maxReturn);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "entity",
    "operation": "READ_SHARED_ENTITIES_LIST",
    "data": {
        "targetProfileId": "profile1",
        "where": {
            "entityType": "address",
            "data.street": "1309 Carling"
        },
        "orderBy": {
            "data.street": 1
        },
        "maxReturn": 50
    }
}

JSON Response

{
    "data": {
        "entities": [
            {
                "entityId": "544db68a-48ad-4fc9-9f44-5fd36fc6445f",
                "entityType": "publicInfo",
                "version": 1,
                "data": {
                    "name": "john",
                    "age": 30
                },
                "acl": {
                    "other": 1
                },
                "createdAt": 1395943044322,
                "updatedAt": 1395943044322
            }
        ],
        "_serverTime": 1637946319239,
        "entityListCount": 1
    },
    "status": 200
}