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

ovr_Challenges_GetEntries Function

Retrieves a list of entries for a specific challenge, with options to filter and limit the results. By providing the challengeID, you can specify which challenge's entries you want to retrieve. The limit parameter allows you to control the number of entries returned. The filter parameter enables you to refine the results to only include entries from users who are bidirectional followers. The startAt parameter allows you to define whether to center the query on the user or start at the top of the challenge. ovrMessage_Challenges_GetEntries 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_GetEntries(ovrID challengeID, int limit, ovrLeaderboardFilterType filter, ovrLeaderboardStartAt startAt)

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.
filter: ovrLeaderboardFilterType By using the ovrLeaderboardFilterType(), you can refine the results to only include entries from users who are bidirectional followers.
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.

Returns