EOS_Leaderboards_QueryLeaderboardDefinitionsOptions

EOS API reference page for EOS_Leaderboards_QueryLeaderboardDefinitionsOptions

This data structure is part of the Leaderboards Interface.

Remarks

Input parameters for the EOS_Leaderboards_QueryLeaderboardDefinitions function. StartTime and EndTime are optional parameters, they can be used to limit the list of definitions to overlap the time window specified.

Properties

EOS_Leaderboards_QueryLeaderboardDefinitionsOptions

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDDEFINITIONS_API_LATEST.

int64_t StartTime

An optional POSIX timestamp for the leaderboard's start time, or EOS_LEADERBOARDS_TIME_UNDEFINED

int64_t EndTime

An optional POSIX timestamp for the leaderboard's end time, or EOS_LEADERBOARDS_TIME_UNDEFINED

EOS_ProductUserId LocalUserId

Product User ID for user who is querying definitions. Must be set when using a client policy that requires a valid logged in user. Not used for Dedicated Server where no user is available.

Related API Members