Package org.drinkless.tdlib

Class TdApi.TdlibParameters

  • Enclosing class:
    TdApi
    public static class TdApi.TdlibParameters
extends TdApi.Object
    Contains parameters for TDLib initialization.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      String apiHash
      Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org.
      int apiId
      Application identifier for Telegram API access, which can be obtained at https://my.telegram.org.
      String applicationVersion
      Application version; must be non-empty.
      static int CONSTRUCTOR
      Identifier uniquely determining type of the object.
      String databaseDirectory
      The path to the directory for the persistent database; if empty, the current working directory will be used.
      String deviceModel
      Model of the device the application is being run on; must be non-empty.
      boolean enableStorageOptimizer
      If set to true, old files will automatically be deleted.
      String filesDirectory
      The path to the directory for storing files; if empty, databaseDirectory will be used.
      boolean ignoreFileNames
      If set to true, original file names will be ignored.
      String systemLanguageCode
      IETF language tag of the user's operating system language; must be non-empty.
      String systemVersion
      Version of the operating system the application is being run on.
      boolean useChatInfoDatabase
      If set to true, the library will maintain a cache of users, basic groups, supergroups, channels and secret chats.
      boolean useFileDatabase
      If set to true, information about downloaded and uploaded files will be saved between application restarts.
      boolean useMessageDatabase
      If set to true, the library will maintain a cache of chats and messages.
      boolean useSecretChats
      If set to true, support for secret chats will be enabled.
      boolean useTestDc
      If set to true, the Telegram test environment will be used instead of the production environment.

    • Constructor Summary

      Constructors 
      Constructor Description
      TdlibParameters()
      Contains parameters for TDLib initialization.
      TdlibParameters​(boolean useTestDc, String databaseDirectory, String filesDirectory, boolean useFileDatabase, boolean useChatInfoDatabase, boolean useMessageDatabase, boolean useSecretChats, int apiId, String apiHash, String systemLanguageCode, String deviceModel, String systemVersion, String applicationVersion, boolean enableStorageOptimizer, boolean ignoreFileNames)
      Contains parameters for TDLib initialization.

    • Field Detail

      • useTestDc

        public boolean useTestDc
        If set to true, the Telegram test environment will be used instead of the production environment.

      • databaseDirectory

        public String databaseDirectory
        The path to the directory for the persistent database; if empty, the current working directory will be used.

      • filesDirectory

        public String filesDirectory
        The path to the directory for storing files; if empty, databaseDirectory will be used.

      • useFileDatabase

        public boolean useFileDatabase
        If set to true, information about downloaded and uploaded files will be saved between application restarts.

      • useChatInfoDatabase

        public boolean useChatInfoDatabase
        If set to true, the library will maintain a cache of users, basic groups, supergroups, channels and secret chats. Implies useFileDatabase.

      • useMessageDatabase

        public boolean useMessageDatabase
        If set to true, the library will maintain a cache of chats and messages. Implies useChatInfoDatabase.

      • useSecretChats

        public boolean useSecretChats
        If set to true, support for secret chats will be enabled.

      • apiId

        public int apiId
        Application identifier for Telegram API access, which can be obtained at https://my.telegram.org.

      • apiHash

        public String apiHash
        Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org.

      • systemLanguageCode

        public String systemLanguageCode
        IETF language tag of the user's operating system language; must be non-empty.

      • deviceModel

        public String deviceModel
        Model of the device the application is being run on; must be non-empty.

      • systemVersion

        public String systemVersion
        Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib.

      • applicationVersion

        public String applicationVersion
        Application version; must be non-empty.

      • enableStorageOptimizer

        public boolean enableStorageOptimizer
        If set to true, old files will automatically be deleted.

      • ignoreFileNames

        public boolean ignoreFileNames
        If set to true, original file names will be ignored. Otherwise, downloaded files will be saved under names as close as possible to the original name.

      • CONSTRUCTOR

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

    • Constructor Detail

      • TdlibParameters

        public TdlibParameters()
        Contains parameters for TDLib initialization.

      • TdlibParameters

        public TdlibParameters​(boolean useTestDc,
                       String databaseDirectory,
                       String filesDirectory,
                       boolean useFileDatabase,
                       boolean useChatInfoDatabase,
                       boolean useMessageDatabase,
                       boolean useSecretChats,
                       int apiId,
                       String apiHash,
                       String systemLanguageCode,
                       String deviceModel,
                       String systemVersion,
                       String applicationVersion,
                       boolean enableStorageOptimizer,
                       boolean ignoreFileNames)
        Contains parameters for TDLib initialization.
        Parameters:
        useTestDc - If set to true, the Telegram test environment will be used instead of the production environment.
        databaseDirectory - The path to the directory for the persistent database; if empty, the current working directory will be used.
        filesDirectory - The path to the directory for storing files; if empty, databaseDirectory will be used.
        useFileDatabase - If set to true, information about downloaded and uploaded files will be saved between application restarts.
        useChatInfoDatabase - If set to true, the library will maintain a cache of users, basic groups, supergroups, channels and secret chats. Implies useFileDatabase.
        useMessageDatabase - If set to true, the library will maintain a cache of chats and messages. Implies useChatInfoDatabase.
        useSecretChats - If set to true, support for secret chats will be enabled.
        apiId - Application identifier for Telegram API access, which can be obtained at https://my.telegram.org.
        apiHash - Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org.
        systemLanguageCode - IETF language tag of the user's operating system language; must be non-empty.
        deviceModel - Model of the device the application is being run on; must be non-empty.
        systemVersion - Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib.
        applicationVersion - Application version; must be non-empty.
        enableStorageOptimizer - If set to true, old files will automatically be deleted.
        ignoreFileNames - If set to true, original file names will be ignored. Otherwise, downloaded files will be saved under names as close as possible to the original name.