host.anzo.eossdk.eos.sdk.leaderboards

Class EOS_Leaderboards_Definition

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.leaderboards.EOS_Leaderboards_Definition

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Leaderboards_Definition.ByReference, EOS_Leaderboards_Definition.ByValue

@Structure.FieldOrder(value={"ApiVersion","LeaderboardId","StatName","Aggregation","StartTime","EndTime"})
public class EOS_Leaderboards_Definition
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

Contains information about a single leaderboard definition

Since:

8/21/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Leaderboards_Definition.ByReference
static class	EOS_Leaderboards_Definition.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
EOS_ELeaderboardAggregation	Aggregation Aggregation used to sort leaderboard.
int	ApiVersion API Version: Set this to EOS_LEADERBOARDS_DEFINITION_API_LATEST.
long	EndTime The POSIX timestamp for the end time, or EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.EOS_LEADERBOARDS_TIME_UNDEFINED.
static int	EOS_LEADERBOARDS_DEFINITION_API_LATEST The most recent version of the EOS_Leaderboards_Definition struct.
java.lang.String	LeaderboardId Unique ID to identify leaderboard.
long	StartTime The POSIX timestamp for the start time, or EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.EOS_LEADERBOARDS_TIME_UNDEFINED.
java.lang.String	StatName Name of stat used to rank leaderboard.

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_Definition()
EOS_Leaderboards_Definition(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method and Description
void	close()
void	release() Release the memory associated with leaderboard record.

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_DEFINITION_API_LATEST

public static final int EOS_LEADERBOARDS_DEFINITION_API_LATEST

The most recent version of the EOS_Leaderboards_Definition struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_LEADERBOARDS_DEFINITION_API_LATEST.

LeaderboardId

public java.lang.String LeaderboardId

Unique ID to identify leaderboard.

StatName

public java.lang.String StatName

Name of stat used to rank leaderboard.

Aggregation

public EOS_ELeaderboardAggregation Aggregation

Aggregation used to sort leaderboard.

StartTime

public long StartTime

The POSIX timestamp for the start time, or EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.EOS_LEADERBOARDS_TIME_UNDEFINED.

EndTime

public long EndTime

The POSIX timestamp for the end time, or EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.EOS_LEADERBOARDS_TIME_UNDEFINED.

Constructor Detail

EOS_Leaderboards_Definition

public EOS_Leaderboards_Definition()

EOS_Leaderboards_Definition

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

Method Detail

release

public void release()

Release the memory associated with leaderboard record. This must be called on data retrieved from EOS_Leaderboards_CopyLeaderboardRecordByIndex or EOS_Leaderboards_CopyLeaderboardRecordByUserId.

See Also:

EOS_Leaderboards_LeaderboardRecord, EOS_Leaderboards_Interface.copyLeaderboardRecordByIndex(EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions), EOS_Leaderboards_Interface.copyLeaderboardRecordByUserId(EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception