host.anzo.eossdk.eos.sdk.leaderboards.options

Class EOS_Leaderboards_QueryLeaderboardDefinitionsOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.leaderboards.options.EOS_Leaderboards_QueryLeaderboardDefinitionsOptions

Direct Known Subclasses:

EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.ByReference, EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","StartTime","EndTime","LocalUserId"})
public class EOS_Leaderboards_QueryLeaderboardDefinitionsOptions
extends com.sun.jna.Structure

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.

Since:

8/21/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.ByReference
static class	EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
int	ApiVersion API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDDEFINITIONS_API_LATEST.
long	EndTime An optional POSIX timestamp for the leaderboard's end time, or EOS_LEADERBOARDS_TIME_UNDEFINED
static int	EOS_LEADERBOARDS_QUERYLEADERBOARDDEFINITIONS_API_LATEST The most recent version of the EOS_Leaderboards_QueryLeaderboardDefinitions struct.
static int	EOS_LEADERBOARDS_TIME_UNDEFINED Timestamp value representing an undefined time for EOS_HLeaderboards.
EOS_ProductUserId	LocalUserId Product User ID for user who is querying definitions.
long	StartTime An optional POSIX timestamp for the leaderboard's start time, or EOS_LEADERBOARDS_TIME_UNDEFINED

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_Leaderboards_QueryLeaderboardDefinitionsOptions()
EOS_Leaderboards_QueryLeaderboardDefinitionsOptions(com.sun.jna.Pointer peer)

Method Summary

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EOS_LEADERBOARDS_TIME_UNDEFINED

public static final int EOS_LEADERBOARDS_TIME_UNDEFINED

Timestamp value representing an undefined time for EOS_HLeaderboards.

See Also:

Constant Field Values

EOS_LEADERBOARDS_QUERYLEADERBOARDDEFINITIONS_API_LATEST

public static final int EOS_LEADERBOARDS_QUERYLEADERBOARDDEFINITIONS_API_LATEST

The most recent version of the EOS_Leaderboards_QueryLeaderboardDefinitions struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDDEFINITIONS_API_LATEST.

StartTime

public long StartTime

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

EndTime

public long EndTime

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

LocalUserId

public 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.

Constructor Detail

EOS_Leaderboards_QueryLeaderboardDefinitionsOptions

public EOS_Leaderboards_QueryLeaderboardDefinitionsOptions()

EOS_Leaderboards_QueryLeaderboardDefinitionsOptions

public EOS_Leaderboards_QueryLeaderboardDefinitionsOptions(com.sun.jna.Pointer peer)