This data structure is part of the Leaderboards Interface.
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.
|
This data structure is part of the Leaderboards Interface.
Input parameters for the {LeaderboardsInterface.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
Leaderboards.QueryLeaderboardDefinitionsOptions
|
Property
|
Value
|
|
int ApiVersion
|
API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDDEFINITIONS_API_LATEST.
|
|
System.DateTimeOffset? StartTime
|
An optional POSIX timestamp for the leaderboard's start time, or EOS_LEADERBOARDS_TIME_UNDEFINED
|
|
System.DateTimeOffset? EndTime
|
An optional POSIX timestamp for the leaderboard's end time, or EOS_LEADERBOARDS_TIME_UNDEFINED
|
|
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.
|
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no