Class EOS_Ecom_QueryEntitlementsOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.ecom.options.EOS_Ecom_QueryEntitlementsOptions
Direct Known Subclasses:
EOS_Ecom_QueryEntitlementsOptions.ByReference, EOS_Ecom_QueryEntitlementsOptions.ByValue

@FieldOrder({"ApiVersion","LocalUserId","EntitlementNames","EntitlementNameCount","IsIncludeRedeemed"}) public class EOS_Ecom_QueryEntitlementsOptions extends com.sun.jna.Structure
Input parameters for the EOS_Ecom_QueryEntitlements function.
Since:
8/20/2023
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
     
    static class 
     

    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
    API Version: Set this to EOS_ECOM_QUERYENTITLEMENTS_API_LATEST.
    int
    The number of Entitlement Names included in the array, up to EOS_ECOM_QUERYENTITLEMENTS_MAX_ENTITLEMENT_IDS; use zero to request all Entitlements associated with the user's Epic Online Services account.
    com.sun.jna.StringArray
    An array of Entitlement Names that you want to check
    static final int
    The most recent version of the EOS_Ecom_QueryEntitlements API.
    static final int
    The maximum number of entitlements that may be queried in a single QueryEntitlements API call.
    If true, Entitlements that have been redeemed will be included in the results.
    The Epic Account ID of the local user whose Entitlements you want to retrieve

    Fields inherited from class com.sun.jna.Structure

    ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    EOS_Ecom_QueryEntitlementsOptions(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_ECOM_QUERYENTITLEMENTS_API_LATEST

      public static final int EOS_ECOM_QUERYENTITLEMENTS_API_LATEST
      The most recent version of the EOS_Ecom_QueryEntitlements API.
      See Also:
    • EOS_ECOM_QUERYENTITLEMENTS_MAX_ENTITLEMENT_IDS

      public static final int EOS_ECOM_QUERYENTITLEMENTS_MAX_ENTITLEMENT_IDS
      The maximum number of entitlements that may be queried in a single QueryEntitlements API call.
      See Also:
    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_ECOM_QUERYENTITLEMENTS_API_LATEST.
    • LocalUserId

      public EOS_EpicAccountId LocalUserId
      The Epic Account ID of the local user whose Entitlements you want to retrieve
    • EntitlementNames

      public com.sun.jna.StringArray EntitlementNames
      An array of Entitlement Names that you want to check
    • EntitlementNameCount

      public int EntitlementNameCount
      The number of Entitlement Names included in the array, up to EOS_ECOM_QUERYENTITLEMENTS_MAX_ENTITLEMENT_IDS; use zero to request all Entitlements associated with the user's Epic Online Services account.
    • IsIncludeRedeemed

      public EOS_Bool IsIncludeRedeemed
      If true, Entitlements that have been redeemed will be included in the results.
  • Constructor Details

    • EOS_Ecom_QueryEntitlementsOptions

      public EOS_Ecom_QueryEntitlementsOptions()
    • EOS_Ecom_QueryEntitlementsOptions

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