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

Class EOS_PlayerDataStorage_ReadFileOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.playerdatastorage.options.EOS_PlayerDataStorage_ReadFileOptions
Direct Known Subclasses:
EOS_PlayerDataStorage_ReadFileOptions.ByReference, EOS_PlayerDataStorage_ReadFileOptions.ByValue
@FieldOrder({"ApiVersion","LocalUserId","Filename","ReadChunkLengthBytes","ReadFileDataCallback","FileTransferProgressCallback"}) public class EOS_PlayerDataStorage_ReadFileOptions extends com.sun.jna.Structure
Since:
8/22/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_PlayerDataStorage_ReadFileOptions.ByReference
     
    static class 
    EOS_PlayerDataStorage_ReadFileOptions.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_PLAYERDATASTORAGE_READFILE_API_LATEST.
    static final int
    EOS_PLAYERDATASTORAGE_READFILE_API_LATEST
     
    String
    Filename
    The file name to read; this file must already exist
    EOS_PlayerDataStorage_OnFileTransferProgressCallback
    FileTransferProgressCallback
    Optional callback function to be informed of download progress, if the file is not already locally cached; if provided, this will be called at least once before completion if the request is successfully started
    EOS_ProductUserId
    LocalUserId
    The Product User ID of the local user who is reading the requested file
    int
    ReadChunkLengthBytes
    The maximum amount of data in bytes should be available to read in a single EOS_PlayerDataStorage_OnReadFileDataCallback call
    EOS_PlayerDataStorage_OnReadFileDataCallback
    ReadFileDataCallback
    Callback function that handles data as it comes in, and can stop the transfer early

    Fields inherited from class com.sun.jna.Structure

    ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    EOS_PlayerDataStorage_ReadFileOptions()
     
    EOS_PlayerDataStorage_ReadFileOptions(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_PLAYERDATASTORAGE_READFILE_API_LATEST

      public static final int EOS_PLAYERDATASTORAGE_READFILE_API_LATEST
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_PLAYERDATASTORAGE_READFILE_API_LATEST.

    • LocalUserId

      public EOS_ProductUserId LocalUserId
      The Product User ID of the local user who is reading the requested file

    • Filename

      public String Filename
      The file name to read; this file must already exist

    • ReadChunkLengthBytes

      public int ReadChunkLengthBytes
      The maximum amount of data in bytes should be available to read in a single EOS_PlayerDataStorage_OnReadFileDataCallback call

    • ReadFileDataCallback

      public EOS_PlayerDataStorage_OnReadFileDataCallback ReadFileDataCallback
      Callback function that handles data as it comes in, and can stop the transfer early

    • FileTransferProgressCallback

      public EOS_PlayerDataStorage_OnFileTransferProgressCallback FileTransferProgressCallback
      Optional callback function to be informed of download progress, if the file is not already locally cached; if provided, this will be called at least once before completion if the request is successfully started

  • Constructor Details

    • EOS_PlayerDataStorage_ReadFileOptions

      public EOS_PlayerDataStorage_ReadFileOptions()

    • EOS_PlayerDataStorage_ReadFileOptions

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