OVR_Requests_Leaderboard.h File

Retrieves detailed information for a single leaderboard with a specified name, returning an array of ovrLeaderboardHandle. A message with type ovrMessage_Leaderboard_Get 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 ovrLeaderboardArrayHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardArray().

Retrieves a list of leaderboard entries for a specified leaderboardName, with options to filter and limit the number of results returned. Error codes

• 100: Parameter {parameter}: invalid user id: {user_id}
• 100: Something went wrong.
• 12074: You're not yet ranked on this leaderboard.

A message with type ovrMessage_Leaderboard_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 ovrLeaderboardEntryArrayHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardEntryArray().

Retrieves a block of leaderboard entries starting from a specific rank. A message with type ovrMessage_Leaderboard_GetEntriesAfterRank 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 ovrLeaderboardEntryArrayHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardEntryArray().

Retrieves a block of leaderboard entries that match the specified user IDs. Only entries corresponding to the provided user IDs will be returned. A message with type ovrMessage_Leaderboard_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 ovrLeaderboardEntryArrayHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardEntryArray().

Requests the next block of leaderboard entries. A message with type ovrMessage_Leaderboard_GetNextEntries 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 ovrLeaderboardEntryArrayHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardEntryArray().

Get the next page of entries A message with type ovrMessage_Leaderboard_GetNextLeaderboardArrayPage 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 ovrLeaderboardArrayHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardArray().

Requests the previous block of leaderboard entries. A message with type ovrMessage_Leaderboard_GetPreviousEntries 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 ovrLeaderboardEntryArrayHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardEntryArray().

Writes a single entry to the leaderboard, returning ovrLeaderboardUpdateStatusHandle indicating whether the update was successful and providing the updated challenge IDs. Error codes

• 100: Parameter {parameter}: invalid user id: {user_id}
• 100: Something went wrong.
• 100: This leaderboard entry is too late for the leaderboard's allowed time window.

A message with type ovrMessage_Leaderboard_WriteEntry 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 ovrLeaderboardUpdateStatusHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardUpdateStatus().

Writes a single entry to a leaderboard which can include supplementary metrics, returning ovrLeaderboardUpdateStatusHandle indicating whether the update was successful and providing the updated challenge IDs. Error codes

• 100: Parameter {parameter}: invalid user id: {user_id}
• 100: Something went wrong.
• 100: This leaderboard entry is too late for the leaderboard's allowed time window.

A message with type ovrMessage_Leaderboard_WriteEntryWithSupplementaryMetric 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 ovrLeaderboardUpdateStatusHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardUpdateStatus().