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

Class EOS_Leaderboards_QueryLeaderboardRanksOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.leaderboards.options.EOS_Leaderboards_QueryLeaderboardRanksOptions
Direct Known Subclasses:
EOS_Leaderboards_QueryLeaderboardRanksOptions.ByReference, EOS_Leaderboards_QueryLeaderboardRanksOptions.ByValue
@FieldOrder({"ApiVersion","LeaderboardId","LocalUserId"}) public class EOS_Leaderboards_QueryLeaderboardRanksOptions extends com.sun.jna.Structure
Input parameters for the EOS_Leaderboards_QueryLeaderboardRanks function.
Since:
8/21/2023
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_Leaderboards_QueryLeaderboardRanksOptions.ByReference
     
    static class 
    EOS_Leaderboards_QueryLeaderboardRanksOptions.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
    Description
    int
    ApiVersion
    API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDRANKS_API_LATEST.
    static final int
    EOS_LEADERBOARDS_QUERYLEADERBOARDRANKS_API_LATEST
    The most recent version of the EOS_Leaderboards_QueryLeaderboardRanks struct.
    String
    LeaderboardId
    The ID of the leaderboard whose information you want to retrieve.
    EOS_ProductUserId
    LocalUserId
    Product User ID for user who is querying ranks.

    Fields inherited from class com.sun.jna.Structure

    ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    EOS_Leaderboards_QueryLeaderboardRanksOptions()
     
    EOS_Leaderboards_QueryLeaderboardRanksOptions(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 Details

    • EOS_LEADERBOARDS_QUERYLEADERBOARDRANKS_API_LATEST

      public static final int EOS_LEADERBOARDS_QUERYLEADERBOARDRANKS_API_LATEST
      The most recent version of the EOS_Leaderboards_QueryLeaderboardRanks struct.
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDRANKS_API_LATEST.

    • LeaderboardId

      public String LeaderboardId
      The ID of the leaderboard whose information you want to retrieve.

    • LocalUserId

      public EOS_ProductUserId LocalUserId
      Product User ID for user who is querying ranks. 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 Details

    • EOS_Leaderboards_QueryLeaderboardRanksOptions

      public EOS_Leaderboards_QueryLeaderboardRanksOptions()

    • EOS_Leaderboards_QueryLeaderboardRanksOptions

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