Module tdlight.api

Class TdApi.LocalFile

java.lang.Object
it.tdlight.jni.TdApi.Object
it.tdlight.jni.TdApi.LocalFile
Enclosing class:
TdApi

public static class TdApi.LocalFile extends TdApi.Object
Represents a local file.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    boolean
    True, if the file can be deleted.
    boolean
    True, if it is possible to try to download or generate the file.
    static final int
     
    int
    If isDownloadingCompleted is false, then only some prefix of the file starting from downloadOffset is ready to be read.
    int
    Total downloaded file size, in bytes.
    int
    Download will be started from this offset.
    boolean
    True, if the file is currently being downloaded (or a local copy is being generated by some other means).
    boolean
    True, if the local copy is fully available.
    Local path to the locally available file part; may be empty.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Represents a local file.
     
    LocalFile(String path, boolean canBeDownloaded, boolean canBeDeleted, boolean isDownloadingActive, boolean isDownloadingCompleted, int downloadOffset, int downloadedPrefixSize, int downloadedSize)
    Represents a local file.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    int
     
    int
     
    void
     

    Methods inherited from class it.tdlight.jni.TdApi.Object

    serialize, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • path

      public String path
      Local path to the locally available file part; may be empty.
    • canBeDownloaded

      public boolean canBeDownloaded
      True, if it is possible to try to download or generate the file.
    • canBeDeleted

      public boolean canBeDeleted
      True, if the file can be deleted.
    • isDownloadingActive

      public boolean isDownloadingActive
      True, if the file is currently being downloaded (or a local copy is being generated by some other means).
    • isDownloadingCompleted

      public boolean isDownloadingCompleted
      True, if the local copy is fully available.
    • downloadOffset

      public int downloadOffset
      Download will be started from this offset. downloadedPrefixSize is calculated from this offset.
    • downloadedPrefixSize

      public int downloadedPrefixSize
      If isDownloadingCompleted is false, then only some prefix of the file starting from downloadOffset is ready to be read. downloadedPrefixSize is the size of that prefix in bytes.
    • downloadedSize

      public int downloadedSize
      Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage.
    • CONSTRUCTOR

      public static final int CONSTRUCTOR
      See Also:
  • Constructor Details

    • LocalFile

      public LocalFile()
      Represents a local file.
    • LocalFile

      public LocalFile(String path, boolean canBeDownloaded, boolean canBeDeleted, boolean isDownloadingActive, boolean isDownloadingCompleted, int downloadOffset, int downloadedPrefixSize, int downloadedSize)
      Represents a local file.
      Parameters:
      path - String Local path to the locally available file part; may be empty.
      canBeDownloaded - boolean True, if it is possible to try to download or generate the file.
      canBeDeleted - boolean True, if the file can be deleted.
      isDownloadingActive - boolean True, if the file is currently being downloaded (or a local copy is being generated by some other means).
      isDownloadingCompleted - boolean True, if the local copy is fully available.
      downloadOffset - int Download will be started from this offset. downloadedPrefixSize is calculated from this offset.
      downloadedPrefixSize - int If isDownloadingCompleted is false, then only some prefix of the file starting from downloadOffset is ready to be read. downloadedPrefixSize is the size of that prefix in bytes.
      downloadedSize - int Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage.
    • LocalFile

      public LocalFile(DataInput input) throws IOException
      Throws:
      IOException
  • Method Details