host.anzo.eossdk.eos.sdk

Class EOS_Leaderboards_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_Leaderboards_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_Leaderboards_Interface
extends com.sun.jna.PointerType

The following EOS_Leaderboards_* functions allow you to query existing leaderboard definitions that have been defined for your application. You can retrieve a list of scores for the top users for each Leaderboard. You can also query scores for one or more users.

Since:

8/21/2023

Constructor Summary

Constructors

Constructor and Description
EOS_Leaderboards_Interface()
EOS_Leaderboards_Interface(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
EOS_Leaderboards_Definition	copyLeaderboardDefinitionByIndex(EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions options) Fetches a leaderboard definition from the cache using an index.
EOS_Leaderboards_Definition	copyLeaderboardDefinitionByLeaderboardId(EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions options) Fetches a leaderboard definition from the cache using a leaderboard ID.
EOS_Leaderboards_LeaderboardRecord	copyLeaderboardRecordByIndex(EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions options) Fetches a leaderboard record from a given index.
EOS_Leaderboards_LeaderboardRecord	copyLeaderboardRecordByUserId(EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions options) Fetches a leaderboard record from a given user ID.
EOS_Leaderboards_LeaderboardUserScore	copyLeaderboardUserScoreByIndex(EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions options) Fetches leaderboard user score from a given index.
EOS_Leaderboards_LeaderboardUserScore	copyLeaderboardUserScoreByUserId(EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions options) Fetches leaderboard user score from a given user ID.
int	getLeaderboardDefinitionCount(EOS_Leaderboards_GetLeaderboardDefinitionCountOptions options) Fetch the number of leaderboards definitions that are cached locally.
int	getLeaderboardRecordCount(EOS_Leaderboards_GetLeaderboardRecordCountOptions options) Fetch the number of leaderboard records that are cached locally.
int	getLeaderboardUserScoreCount(EOS_Leaderboards_GetLeaderboardUserScoreCountOptions options) Fetch the number of leaderboard user scores that are cached locally.
void	queryLeaderboardDefinitions(EOS_Leaderboards_QueryLeaderboardDefinitionsOptions options, com.sun.jna.Pointer clientData, EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallback completionDelegate) Query for a list of existing leaderboards definitions including their attributes.
void	queryLeaderboardRanks(EOS_Leaderboards_QueryLeaderboardRanksOptions options, com.sun.jna.Pointer clientData, EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallback completionDelegate) Retrieves top leaderboard records by rank in the leaderboard matching the given leaderboard ID.
void	queryLeaderboardUserScores(EOS_Leaderboards_QueryLeaderboardUserScoresOptions options, com.sun.jna.Pointer clientData, EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallback completionDelegate) Query for a list of scores for a given list of users.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EOS_Leaderboards_Interface

public EOS_Leaderboards_Interface(com.sun.jna.Pointer address)

EOS_Leaderboards_Interface

public EOS_Leaderboards_Interface()

Method Detail

queryLeaderboardDefinitions

public void queryLeaderboardDefinitions(EOS_Leaderboards_QueryLeaderboardDefinitionsOptions options,
                                        com.sun.jna.Pointer clientData,
                                        EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallback completionDelegate)

Query for a list of existing leaderboards definitions including their attributes.

Parameters:

options - Structure containing information about the application whose leaderboard definitions we're retrieving.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

completionDelegate - This function is called when the query operation completes.

getLeaderboardDefinitionCount

public int getLeaderboardDefinitionCount(EOS_Leaderboards_GetLeaderboardDefinitionCountOptions options)

Fetch the number of leaderboards definitions that are cached locally.

Parameters:

options - The Options associated with retrieving the leaderboard count.

Returns:

Number of leaderboards or 0 if there is an error

See Also:

copyLeaderboardDefinitionByIndex(EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions), copyLeaderboardDefinitionByLeaderboardId(EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions)

copyLeaderboardDefinitionByIndex

public EOS_Leaderboards_Definition copyLeaderboardDefinitionByIndex(EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions options)
                                                             throws EOSException

Fetches a leaderboard definition from the cache using an index.

Parameters:

options - Structure containing the index being accessed.

Returns:

The leaderboard data for the given index, if it exists and is valid, use EOS_Leaderboards_Definition_Release when finished.

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the leaderboard is not found

EOSException

See Also:

EOS_Leaderboards_Definition.release()

copyLeaderboardDefinitionByLeaderboardId

public EOS_Leaderboards_Definition copyLeaderboardDefinitionByLeaderboardId(EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions options)
                                                                     throws EOSException

Fetches a leaderboard definition from the cache using a leaderboard ID.

Parameters:

options - Structure containing the leaderboard ID being accessed.

Returns:

The leaderboard definition for the given leaderboard ID, if it exists and is valid, use EOS_Leaderboards_Definition_Release when finished.

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the leaderboard data is not found

EOSException

See Also:

EOS_Leaderboards_Definition.release()

queryLeaderboardRanks

public void queryLeaderboardRanks(EOS_Leaderboards_QueryLeaderboardRanksOptions options,
                                  com.sun.jna.Pointer clientData,
                                  EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallback completionDelegate)

Retrieves top leaderboard records by rank in the leaderboard matching the given leaderboard ID.

Parameters:

options - Structure containing information about the leaderboard records we're retrieving.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

completionDelegate - This function is called when the query operation completes.

getLeaderboardRecordCount

public int getLeaderboardRecordCount(EOS_Leaderboards_GetLeaderboardRecordCountOptions options)

Fetch the number of leaderboard records that are cached locally.

Parameters:

options - The Options associated with retrieving the leaderboard record count.

Returns:

Number of leaderboard records or 0 if there is an error

See Also:

copyLeaderboardRecordByIndex(EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions), copyLeaderboardRecordByUserId(EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions)

copyLeaderboardRecordByIndex

public EOS_Leaderboards_LeaderboardRecord copyLeaderboardRecordByIndex(EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions options)
                                                                throws EOSException

Fetches a leaderboard record from a given index.

Parameters:

options - Structure containing the index being accessed.

Returns:

The leaderboard record for the given index, if it exists and is valid, use EOS_Leaderboards_LeaderboardRecord_Release when finished.

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the leaderboard is not found

EOSException

See Also:

EOS_Leaderboards_LeaderboardRecord.release()

copyLeaderboardRecordByUserId

public EOS_Leaderboards_LeaderboardRecord copyLeaderboardRecordByUserId(EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions options)
                                                                 throws EOSException

Fetches a leaderboard record from a given user ID.

Parameters:

options - Structure containing the user ID being accessed.

Returns:

The leaderboard record for the given user ID, if it exists and is valid, use EOS_Leaderboards_LeaderboardRecord_Release when finished.

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the leaderboard data is not found

EOSException

See Also:

EOS_Leaderboards_LeaderboardRecord.release()

queryLeaderboardUserScores

public void queryLeaderboardUserScores(EOS_Leaderboards_QueryLeaderboardUserScoresOptions options,
                                       com.sun.jna.Pointer clientData,
                                       EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallback completionDelegate)

Query for a list of scores for a given list of users.

Parameters:

options - Structure containing information about the users whose scores we're retrieving.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

completionDelegate - This function is called when the query operation completes.

getLeaderboardUserScoreCount

public int getLeaderboardUserScoreCount(EOS_Leaderboards_GetLeaderboardUserScoreCountOptions options)

Fetch the number of leaderboard user scores that are cached locally.

Parameters:

options - The Options associated with retrieving the leaderboard user scores count.

Returns:

Number of leaderboard records or 0 if there is an error

See Also:

copyLeaderboardUserScoreByIndex(EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions), copyLeaderboardUserScoreByUserId(EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions)

copyLeaderboardUserScoreByIndex

public EOS_Leaderboards_LeaderboardUserScore copyLeaderboardUserScoreByIndex(EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions options)
                                                                      throws EOSException

Fetches leaderboard user score from a given index.

Parameters:

options - Structure containing the index being accessed.

Returns:

The leaderboard user score for the given index, if it exists and is valid, use EOS_Leaderboards_LeaderboardUserScore_Release when finished.

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the leaderboard user scores are not found

EOSException

See Also:

EOS_Leaderboards_LeaderboardUserScore.release()

copyLeaderboardUserScoreByUserId

public EOS_Leaderboards_LeaderboardUserScore copyLeaderboardUserScoreByUserId(EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions options)
                                                                       throws EOSException

Fetches leaderboard user score from a given user ID.

Parameters:

options - Structure containing the user ID being accessed.

Returns:

The leaderboard user score for the given user ID, if it exists and is valid, use EOS_Leaderboards_LeaderboardUserScore_Release when finished.

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the leaderboard user scores are not found

EOSException

See Also:

EOS_Leaderboards_LeaderboardUserScore.release()