FindUserByUniversalId

Retrieves user information for partially matched universal IDs. Optional parameter: maxResults.

caution

This API is deprecated and will be removed in the future. Please use the FindUserByExactUniversalId API instead.

Service	Operation
friend	FIND_PLAYER_BY_UNIVERSAL_ID

Method Parameters

Parameter	Description
searchText	The substring to search for. Minimum length of 3 characters.
maxResults	Maximum number of results to return. If there are more the message.

Usage

http://localhost:3000

C#

string searchText = "someText";
int maxResults = 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.FriendService.FindUserByUniversalId(searchText, maxResults, successCallback, failureCallback);

C++

const char *searchText = "someText";
int maxResults = 5;
_bc.getFriendService().findUserByUniversalId(searchText, maxResults, this);

Objective-C

NSString *searchText = @"someText";
int maxResults = 5;
BCCompletionBlock successBlock; // define callback
BCErrorCompletionBlock failureBlock; // define callback
[[_bc friendService] FindUserByUniversalId:
                   searchText:searchText
                   maxResults:maxResults
              completionBlock:successBlock
         errorCompletionBlock:failureBlock
                     cbObject:nil]

Java

String searchText = "someText";
int maxResults = 5;
this; // implements IServerCallback
_bc.getFriendService.FindUserByUniversalId(searchText, maxResults, 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 searchText = "someText";
var maxResults = 5;
_bc.friend.FindUserByUniversalId(searchText, maxResults, result =>
{
  var status = result.status;
  console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

// N/A

Cloud Code

var searchText = "someText";
var maxResults = 5;
var friendProxy = bridge.getFriendServiceProxy();

var postResult = friendProxy.FindUserByUniversalId(searchText, maxResults);

Raw

{
    "service":"friend",
    "operation":"FIND_PLAYER_BY_UNIVERSAL_ID",
    "data":{
        "searchText":"someText",
        "maxResults":5
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "matchedCount": 1,
        "matches": [
            {
                "profileId": "111-222-333",
                "profileName": "UserA",
                "summaryFriendData": null,
                "pictureUrl": null
            }
        ]
    }
}