Package org.drinkless.tdlib

# Class TdApi.OptimizeStorage

java.lang.Object
org.drinkless.tdlib.TdApi.Object
org.drinkless.tdlib.TdApi.Function<TdApi.StorageStatistics>
org.drinkless.tdlib.TdApi.OptimizeStorage

Enclosing class:
  TdApi

public static class TdApi.OptimizeStorage extends TdApi.Function<TdApi.StorageStatistics>
Optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted.

Returns `StorageStatistics`

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class org.drinkless.tdlib.TdApi.Function

  `TdApi.Function.Constructors`

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `long[]`
  `chatIds`
  If non-empty, only files from the given chats are considered.
  `int`
  `chatLimit`
  Same as in getStorageStatistics.
  `static final int`
  `CONSTRUCTOR`
  Identifier uniquely determining type of the object.
  `int`
  `count`
  Limit on the total number of files after deletion.
  `long[]`
  `excludeChatIds`
  If non-empty, files from the given chats are excluded.
  `TdApi.FileType[]`
  `fileTypes`
  If non-empty, only files with the given types are considered.
  `int`
  `immunityDelay`
  The amount of time after the creation of a file during which it can't be deleted, in seconds.
  `boolean`
  `returnDeletedFileStatistics`
  Pass true if statistics about the files that were deleted must be returned instead of the whole storage usage statistics.
  `long`
  `size`
  Limit on the total size of files after deletion, in bytes.
  `int`
  `ttl`
  Limit on the time that has passed since the last time a file was accessed (or creation time for some filesystems).

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `OptimizeStorage()`
  Default constructor for a function, which optimizes storage usage, i.e.
  `OptimizeStorage(long size, int ttl, int count, int immunityDelay, TdApi.FileType[] fileTypes, long[] chatIds, long[] excludeChatIds, boolean returnDeletedFileStatistics, int chatLimit)`
  Creates a function, which optimizes storage usage, i.e.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getConstructor()`
  Returns an identifier uniquely determining type of the object.

  ### Methods inherited from class org.drinkless.tdlib.TdApi.Function

  `toString`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Field Details

  - ### size

    public long size
    Limit on the total size of files after deletion, in bytes. Pass -1 to use the default limit.

  - ### ttl

    public int ttl
    Limit on the time that has passed since the last time a file was accessed (or creation time for some filesystems). Pass -1 to use the default limit.

  - ### count

    public int count
    Limit on the total number of files after deletion. Pass -1 to use the default limit.

  - ### immunityDelay

    public int immunityDelay
    The amount of time after the creation of a file during which it can't be deleted, in seconds. Pass -1 to use the default value.

  - ### fileTypes

    public TdApi.FileType[] fileTypes
    If non-empty, only files with the given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted.

  - ### chatIds

    public long[] chatIds
    If non-empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat (e.g., profile photos).

  - ### excludeChatIds

    public long[] excludeChatIds
    If non-empty, files from the given chats are excluded. Use 0 as chat identifier to exclude all files not belonging to any chat (e.g., profile photos).

  - ### returnDeletedFileStatistics

    public boolean returnDeletedFileStatistics
    Pass true if statistics about the files that were deleted must be returned instead of the whole storage usage statistics. Affects only returned statistics.

  - ### chatLimit

    public int chatLimit
    Same as in getStorageStatistics. Affects only returned statistics.

  - ### CONSTRUCTOR

    public static final int CONSTRUCTOR
    Identifier uniquely determining type of the object.
    See Also:
      - Constant Field Values

- ## Constructor Details

  - ### OptimizeStorage

    public OptimizeStorage()
    Default constructor for a function, which optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted.

    Returns `StorageStatistics`

  - ### OptimizeStorage

    public OptimizeStorage(long size, int ttl, int count, int immunityDelay, TdApi.FileType[] fileTypes, long[] chatIds, long[] excludeChatIds, boolean returnDeletedFileStatistics, int chatLimit)
    Creates a function, which optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted.

    Returns `StorageStatistics`

    Parameters:
      `size` - Limit on the total size of files after deletion, in bytes. Pass -1 to use the default limit.
      `ttl` - Limit on the time that has passed since the last time a file was accessed (or creation time for some filesystems). Pass -1 to use the default limit.
      `count` - Limit on the total number of files after deletion. Pass -1 to use the default limit.
      `immunityDelay` - The amount of time after the creation of a file during which it can't be deleted, in seconds. Pass -1 to use the default value.
      `fileTypes` - If non-empty, only files with the given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted.
      `chatIds` - If non-empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat (e.g., profile photos).
      `excludeChatIds` - If non-empty, files from the given chats are excluded. Use 0 as chat identifier to exclude all files not belonging to any chat (e.g., profile photos).
      `returnDeletedFileStatistics` - Pass true if statistics about the files that were deleted must be returned instead of the whole storage usage statistics. Affects only returned statistics.
      `chatLimit` - Same as in getStorageStatistics. Affects only returned statistics.

- ## Method Details

  - ### getConstructor

    public int getConstructor()
    Description copied from class: `TdApi.Object`
    Returns an identifier uniquely determining type of the object.
    Specified by:
      `getConstructor` in class `TdApi.Function<TdApi.StorageStatistics>`
    Returns:
      this.CONSTRUCTOR