Skip to main content
Version: 5.7.0

FindUsersByUniversalIdStartingWith

Retrieves profile information for users whose universal ID starts with search text. Optional parameter: maxResults

ServiceOperation
friendFIND_USERS_BY_UNIVERSAL_ID_STARTING_WITH

Method Parameters

ParameterDescription
searchTextThe substring to search for. Minimum length of 3 characters.
maxResultsMaximum number of results to return. If there are more the message.

Usage

http://localhost:3000
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.FindUsersByUniversalIdStartingWith(searchText, maxResults, successCallback, failureCallback);
JSON Response
{
"status":200,
"data":{
"matchedCount":2,
"message":"Result count exceeds maximum.",
"matches":[
{
"profileId":"111-222-333",
"profileName":"UserA",
"summaryFriendData":null,
"pictureUrl":null
},
{
"profileId":"aaa-bbb-ccc",
"profileName":"UserB",
"summaryFriendData":null,
"pictureUrl":null
}
]
}
}