org.drinkless.tdlib

Class TdApi.SetTdlibParameters

java.lang.Object

org.drinkless.tdlib.TdApi.Object

org.drinkless.tdlib.TdApi.Function<TdApi.Ok>

org.drinkless.tdlib.TdApi.SetTdlibParameters

Enclosing class:

TdApi

public static class TdApi.SetTdlibParameters
extends TdApi.Function<TdApi.Ok>

Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters.

Returns Ok

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.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.
java.lang.String	applicationVersion Application version; must be non-empty.
static int	CONSTRUCTOR Identifier uniquely determining type of the object.
java.lang.String	databaseDirectory The path to the directory for the persistent database; if empty, the current working directory will be used.
byte[]	databaseEncryptionKey Encryption key for the database.
java.lang.String	deviceModel Model of the device the application is being run on; must be non-empty.
java.lang.String	filesDirectory The path to the directory for storing files; if empty, databaseDirectory will be used.
java.lang.String	systemLanguageCode IETF language tag of the user's operating system language; must be non-empty.
java.lang.String	systemVersion Version of the operating system the application is being run on.
boolean	useChatInfoDatabase Pass true to keep cache of users, basic groups, supergroups, channels and secret chats between restarts.
boolean	useFileDatabase Pass true to keep information about downloaded and uploaded files between application restarts.
boolean	useMessageDatabase Pass true to keep cache of chats and messages between restarts.
boolean	useSecretChats Pass true to enable support for secret chats.
boolean	useTestDc Pass true to use Telegram test environment instead of the production environment.

Constructor Summary

Constructors

Constructor and Description
SetTdlibParameters() Default constructor for a function, which sets the parameters for TDLib initialization.
SetTdlibParameters(boolean useTestDc, java.lang.String databaseDirectory, java.lang.String filesDirectory, byte[] databaseEncryptionKey, boolean useFileDatabase, boolean useChatInfoDatabase, boolean useMessageDatabase, boolean useSecretChats, int apiId, java.lang.String apiHash, java.lang.String systemLanguageCode, java.lang.String deviceModel, java.lang.String systemVersion, java.lang.String applicationVersion) Creates a function, which sets the parameters for TDLib initialization.

Method Summary

Modifier and Type	Method and 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 Detail

useTestDc

public boolean useTestDc

Pass true to use Telegram test environment instead of the production environment.

databaseDirectory

public java.lang.String databaseDirectory

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

filesDirectory

public java.lang.String filesDirectory

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

databaseEncryptionKey

public byte[] databaseEncryptionKey

Encryption key for the database. If the encryption key is invalid, then an error with code 401 will be returned.

useFileDatabase

public boolean useFileDatabase

Pass true to keep information about downloaded and uploaded files between application restarts.

useChatInfoDatabase

public boolean useChatInfoDatabase

Pass true to keep cache of users, basic groups, supergroups, channels and secret chats between restarts. Implies useFileDatabase.

useMessageDatabase

public boolean useMessageDatabase

Pass true to keep cache of chats and messages between restarts. Implies useChatInfoDatabase.

useSecretChats

public boolean useSecretChats

Pass true to enable support for secret chats.

apiId

public int apiId

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

apiHash

public java.lang.String apiHash

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

systemLanguageCode

public java.lang.String systemLanguageCode

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

deviceModel

public java.lang.String deviceModel

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

systemVersion

public java.lang.String systemVersion

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

applicationVersion

public java.lang.String applicationVersion

Application version; must be non-empty.

CONSTRUCTOR

public static final int CONSTRUCTOR

Identifier uniquely determining type of the object.

See Also:

Constant Field Values

Constructor Detail

SetTdlibParameters

public SetTdlibParameters()

Default constructor for a function, which sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters.

Returns Ok

SetTdlibParameters

public SetTdlibParameters(boolean useTestDc,
                          java.lang.String databaseDirectory,
                          java.lang.String filesDirectory,
                          byte[] databaseEncryptionKey,
                          boolean useFileDatabase,
                          boolean useChatInfoDatabase,
                          boolean useMessageDatabase,
                          boolean useSecretChats,
                          int apiId,
                          java.lang.String apiHash,
                          java.lang.String systemLanguageCode,
                          java.lang.String deviceModel,
                          java.lang.String systemVersion,
                          java.lang.String applicationVersion)

Creates a function, which sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters.

Returns Ok

Parameters:

useTestDc - Pass true to use Telegram test environment 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.

databaseEncryptionKey - Encryption key for the database. If the encryption key is invalid, then an error with code 401 will be returned.

useFileDatabase - Pass true to keep information about downloaded and uploaded files between application restarts.

useChatInfoDatabase - Pass true to keep cache of users, basic groups, supergroups, channels and secret chats between restarts. Implies useFileDatabase.

useMessageDatabase - Pass true to keep cache of chats and messages between restarts. Implies useChatInfoDatabase.

useSecretChats - Pass true to enable support for secret chats.

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.

Method Detail

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.Object

Returns:

this.CONSTRUCTOR