API reference
API reference
Select your platform
No SDKs available
No versions available

ovr_Challenges_GetEntriesByIds Function

Retrieves a list of challenge entries for a specific set of user IDs, with options to filter and limit the results. This method is useful for retrieving a list of challenge entries for a specific set of users, allowing you to display their progress and rankings within the challenge. ovrMessage_Challenges_GetEntriesByIds will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrChallengeEntryArrayHandle. Extract the payload from the message handle with ovr_Message_GetChallengeEntryArray().

Signature

ovrRequest ovr_Challenges_GetEntriesByIds(ovrID challengeID, int limit, ovrLeaderboardStartAt startAt, ovrID *userIDs, unsigned int userIDLength)

Parameters

challengeID: ovrID The id of the challenge whose entries to return, which can be retrieved by calling ovr_Challenge_GetID().
limit: int Sets a limit on the maximum number of challenges to be fetched, which can be useful for pagination or performance reasons.
startAt: ovrLeaderboardStartAt Defines whether to center the query on the user or start at the top of the challenge. If this is ovrLeaderboard_StartAtCenteredOnViewer() or ovrLeaderboard_StartAtCenteredOnViewerOrTop(), then the current user's ID will be automatically added to the query.
userIDs: ovrID * Defines a list of user ids to get entries for.
userIDLength: unsigned int The number of user IDs provided.

Returns