Friend

Friends in brainCloud are other users (i.e. players) that you want to share your user experience with. Friends may be existing connections from a social network (i.e. Facebook), or social connections that you make that are specific to the app and managed by brainCloud.

API Summary

User Lookup

By Universal ID:

• FindUserByExactUniversalId - Retrieves profile information for the partial Universal ID matches of the specified text.
• FindUsersByUniversalIdStartingWith - Retrieves profile information for users whose universal ID starts with search text. Optional parameter: maxResults

By Name (not recommended - slow!):

• FindUsersByExactName - Retrieves profile information for exactly matched user names. Optional parameter: maxResults
• FindUsersBySubstrName - Retrieves profile information for partially matched user names. Optional parameter: maxResults
• FindUsersByNameStartingWith - Retrieves profile information for users whose name starts with search text. Optional parameter: maxResults

By Other Identity:

• GetProfileInfoForCredential - Retrieves profile information for the specified user.
• GetProfileInfoForCredentialIfExists - Retrieves profile information for the specified user. Silently fails
• GetProfileInfoForExternalAuthId - Retrieves profile information for the specified user.
• GetProfileInfoForExternalAuthIdIfExists - Retrieves profile information for the specified user. Silently fails

Misc:

• FindUsersByUserSummary - Retrieves profile information based on the search criteria of the user summary data.
• GetUsersOnlineStatus - Get users online status.
• GetExternalIdForProfileId - Retrieves the external ID for the specified user profile ID on the specified social platform.
• GetSummaryDataForProfileId - Retrieves summary information for the specified user profile ID.

tip

Note that friends APIs in S2S are disigned for user retrival purpose, it does not require the calling user (S2S session) to be a friend of the retrieved users.

📄️ FindUsersByExactName

Retrieves profile information for the exact matches of the specified text.