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

LeaderboardUpdateStatus Interface

This object is a response from the server that contains information about the status of the request to update the leaderboard. It can be retrieved using two different API requests: Leaderboards.writeEntry and Leaderboards.writeEntryWithSupplementaryMetric.

Signature

interface LeaderboardUpdateStatus

Properties

didUpdate : Boolean
[Get]
A boolean indicates whether the leaderboard was updated.
Signature
abstract val didUpdate: Boolean
updatedChallengeIds : List?
[Get]
If the leaderboard is updated, this represents the updated challenge IDs. The updated challenge IDs can be used by horizon.platform.challenges.Challenges.getEntries, horizon.platform.challenges.Challenges.getEntriesAfterRank, or horizon.platform.challenges.Challenges.getEntriesByIds APIs.
Signature
abstract val updatedChallengeIds: List<String>?
Did you find this page helpful?