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

Class EOS_PlayerDataStorage_WriteFileOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.playerdatastorage.options.EOS_PlayerDataStorage_WriteFileOptions
Direct Known Subclasses:
EOS_PlayerDataStorage_WriteFileOptions.ByReference, EOS_PlayerDataStorage_WriteFileOptions.ByValue
@FieldOrder({"ApiVersion","LocalUserId","Filename","ChunkLengthBytes","WriteFileDataCallback","FileTransferProgressCallback"}) public class EOS_PlayerDataStorage_WriteFileOptions extends com.sun.jna.Structure
Input data for the EOS_PlayerDataStorage_WriteFile function
Since:
8/22/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_PlayerDataStorage_WriteFileOptions.ByReference
     
    static class 
    EOS_PlayerDataStorage_WriteFileOptions.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_WRITEFILE_API_LATEST.
    int
    ChunkLengthBytes
    Requested maximum amount of data (in bytes) that can be written to the file per tick
    static final int
    EOS_PLAYERDATASTORAGE_WRITEFILE_API_LATEST
    The most recent version of the EOS_PlayerDataStorage_WriteFile API.
    String
    Filename
    The name of the file to write; if this file already exists, the contents will be replaced if the write request completes successfully
    EOS_PlayerDataStorage_OnFileTransferProgressCallback
    FileTransferProgressCallback
    Optional callback function to inform the application of upload progress; will be called at least once if set
    EOS_ProductUserId
    LocalUserId
    The Product User ID of the local user who is writing the requested file to the cloud
    EOS_PlayerDataStorage_OnWriteFileDataCallback
    WriteFileDataCallback
    Callback function that provides chunks of data to be written into the requested file

    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_WriteFileOptions()
     
    EOS_PlayerDataStorage_WriteFileOptions(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_WRITEFILE_API_LATEST

      public static final int EOS_PLAYERDATASTORAGE_WRITEFILE_API_LATEST
      The most recent version of the EOS_PlayerDataStorage_WriteFile API.
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_PLAYERDATASTORAGE_WRITEFILE_API_LATEST.

    • LocalUserId

      public EOS_ProductUserId LocalUserId
      The Product User ID of the local user who is writing the requested file to the cloud

    • Filename

      public String Filename
      The name of the file to write; if this file already exists, the contents will be replaced if the write request completes successfully

    • ChunkLengthBytes

      public int ChunkLengthBytes
      Requested maximum amount of data (in bytes) that can be written to the file per tick

    • WriteFileDataCallback

      public EOS_PlayerDataStorage_OnWriteFileDataCallback WriteFileDataCallback
      Callback function that provides chunks of data to be written into the requested file

    • FileTransferProgressCallback

      public EOS_PlayerDataStorage_OnFileTransferProgressCallback FileTransferProgressCallback
      Optional callback function to inform the application of upload progress; will be called at least once if set

  • Constructor Details

    • EOS_PlayerDataStorage_WriteFileOptions

      public EOS_PlayerDataStorage_WriteFileOptions()

    • EOS_PlayerDataStorage_WriteFileOptions

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