<divid="dev_page_content"><p><ahref="/tdlib">TDLib</a> has many options that affect the behavior of the library. Each option has a <strong>name</strong> and a <strong>value</strong>. <strong>Value</strong> may be of one of the following types:</p>
<tableclass="table">
<tbody>
<tr>
<td><strong>Type of value</strong></td>
<td><strong>Default value</strong></td>
<td><strong>Value range</strong></td>
</tr>
<tr>
<td>Integer</td>
<td>0</td>
<td>64-bit integer</td>
</tr>
<tr>
<td>Boolean</td>
<td>false</td>
<td>True or false</td>
</tr>
<tr>
<td>String</td>
<td></td>
<td>Any Unicode string</td>
</tr>
</tbody>
</table>
<h1><aclass="anchor"name="list-of-options-supported-by-tdlib"href="#list-of-options-supported-by-tdlib"><iclass="anchor-icon"></i></a>List of options supported by TDLib</h1>
<p>Options not mentioned in this list may be safely ignored.</p>
<tableclass="table">
<tbody>
<tr>
<td><strong>Name</strong></td>
<td><strong>Type</strong></td>
<td><strong>Writable</strong></td>
<td><strong>Description</strong></td>
</tr>
<tr>
<td>always_parse_markdown</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, text entities will be automatically parsed in all <code>inputMessageText</code> objects</td>
<td>If true, new chats from non-contacts will be automatically archived and muted. The option can be set only if the option “can_archive_and_mute_new_chats_from_unknown_users” is true. <code>getOption</code> needs to be called explicitly to fetch the latest value of the option, changed from another device</td>
</tr>
<tr>
<td>disable_animated_emoji</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, animated emoji will be disabled and shown as plain emoji</td>
</tr>
<tr>
<td>disable_contact_registered_notifications</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, notifications about the user's contacts who have joined Telegram will be disabled. User will still receive the corresponding message in the private chat. <code>getOption</code> needs to be called explicitly to fetch the latest value of the option, changed from another device</td>
</tr>
<tr>
<td>disable_persistent_network_statistics</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, persistent network statistics will be disabled, which significantly reduces disk usage</td>
<td>If true, notifications about outgoing scheduled messages that were sent will be disabled</td>
</tr>
<tr>
<td>disable_time_adjustment_protection</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, protection from external time adjustment will be disabled, which significantly reduces disk usage</td>
</tr>
<tr>
<td>disable_top_chats</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, support for top chats and statistics collection is disabled</td>
</tr>
<tr>
<td>ignore_background_updates</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, allows to skip all updates received while the TDLib instance was not running. The option does nothing if the database or secret chats are used</td>
</tr>
<tr>
<td>ignore_default_disable_notification</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, the <code>disable_notification</code> value specified in the request will be always used instead of the default value</td>
</tr>
<tr>
<td>ignore_inline_thumbnails</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, prevents file thumbnails sent by the server along with messages from being saved on the disk</td>
</tr>
<tr>
<td>ignore_platform_restrictions</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, chat and message restrictions specific to the currently used operating system will be ignored</td>
</tr>
<tr>
<td>ignore_sensitive_content_restrictions</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, sensitive content will be shown on all user devices. <code>getOption</code> needs to be called explicitly to fetch the latest value of the option, changed from another device</td>
</tr>
<tr>
<td>is_location_visible</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, other users will be allowed to see the current user's location. <code>getOption</code> needs to be called explicitly to fetch the latest value of the option, changed from another device</td>
</tr>
<tr>
<td>language_pack_database_path</td>
<td>String</td>
<td>Yes</td>
<td>Path to a database for storing language pack strings, so that this database can be shared between different accounts. By default, language pack strings are stored only in memory. Changes of value of this option will be applied only after TDLib restart, so it should be set before call to <code>setTdlibParameters</code>.</td>
</tr>
<tr>
<td>language_pack_id</td>
<td>String</td>
<td>Yes</td>
<td>Identifier of the currently used language pack from the current localization target</td>
</tr>
<tr>
<td>localization_target</td>
<td>String</td>
<td>Yes</td>
<td>Name for the current localization target (currently supported: “android”, “android_x”, “ios”, “macos” and “tdesktop”)</td>
</tr>
<tr>
<td>message_unload_delay</td>
<td>Integer</td>
<td>Yes</td>
<td>The maximum time messages are stored in memory before they are unloaded, 60-86400; in seconds. Defaults to 60 for users and 1800 for bots</td>
</tr>
<tr>
<td>notification_group_count_max</td>
<td>Integer</td>
<td>Yes</td>
<td>Maximum number of notification groups to be shown simultaneously, 0-25</td>
</tr>
<tr>
<td>notification_group_size_max</td>
<td>Integer</td>
<td>Yes</td>
<td>Maximum number of simultaneously shown notifications in a group, 1-25. Defaults to 10</td>
</tr>
<tr>
<td>online</td>
<td>Boolean</td>
<td>Yes</td>
<td>Online status of the current user</td>
</tr>
<tr>
<td>prefer_ipv6</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, IPv6 addresses will be preferred over IPv4 addresses</td>
</tr>
<tr>
<td>use_pfs</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, Perfect Forward Secrecy will be enabled for interaction with the Telegram servers for cloud chats</td>
</tr>
<tr>
<td>use_quick_ack</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, quick acknowledgement will be enabled for outgoing messages</td>
</tr>
<tr>
<td>use_storage_optimizer</td>
<td>Boolean</td>
<td>Yes</td>
<td>If true, the background storage optimizer will be enabled</td>
</tr>
<tr>
<td>utc_time_offset</td>
<td>Integer</td>
<td>Yes</td>
<td>A UTC time offset used for splitting messages by days. The option is reset automatically on each TDLib instance launch, so it needs to be set manually only if the time offset is changed during execution.</td>
</tr>
<tr>
<td>animation_search_bot_username</td>
<td>String</td>
<td>No</td>
<td>Username of a bot which can be used in inline mode for animations search</td>
</tr>
<tr>
<td>authentication_token</td>
<td>String</td>
<td>No</td>
<td>An authentication token to be used on subsequent authorizations and received when logging out</td>
</tr>
<tr>
<td>authorization_date</td>
<td>Integer</td>
<td>No</td>
<td>Point in time (Unix timestamp) when authorization was received</td>
</tr>
<tr>
<td>basic_group_size_max</td>
<td>Integer</td>
<td>No</td>
<td>Maximum number of members in a basic group</td>
</tr>
<tr>
<td>call_connect_timeout_ms</td>
<td>Integer</td>
<td>No</td>
<td>Maximum time to wait for call connection creation to be passed to libtgvoip</td>
</tr>
<tr>
<td>call_packet_timeout_ms</td>
<td>Integer</td>
<td>No</td>
<td>Maximum time to wait for call packet delivery to be passed to libtgvoip</td>
<td>If true, the option “ignore_sensitive_content_restrictions” can be changed</td>
</tr>
<tr>
<td>channel_bot_user_id</td>
<td>Integer</td>
<td>No</td>
<td>Identifier of the bot which is shown as the sender of messages sent on behalf of channels when viewed from an outdated client</td>
</tr>
<tr>
<td>enabled_proxy_id</td>
<td>Integer</td>
<td>No</td>
<td>Identifier of the enabled proxy</td>
</tr>
<tr>
<td>expect_blocking</td>
<td>Boolean</td>
<td>No</td>
<td>If true, access to Telegram is likely blocked for the user</td>
</tr>
<tr>
<td>favorite_stickers_limit</td>
<td>Integer</td>
<td>No</td>
<td>Maximum number of favorite stickers</td>
</tr>
<tr>
<td>forwarded_message_count_max</td>
<td>Integer</td>
<td>No</td>
<td>Maximum number of forwarded messages per one request</td>
</tr>
<tr>
<td>group_anonymous_bot_user_id</td>
<td>Integer</td>
<td>No</td>
<td>Identifier of the bot which is shown as the sender of anonymous messages in groups when viewed from an outdated client</td>
</tr>
<tr>
<td>message_caption_length_max</td>
<td>Integer</td>
<td>No</td>
<td>Maximum length of a message caption</td>
</tr>
<tr>
<td>message_text_length_max</td>
<td>Integer</td>
<td>No</td>
<td>Maximum length of a message text</td>
</tr>
<tr>
<td>my_id</td>
<td>Integer</td>
<td>No</td>
<td>Identifier of the current user</td>
</tr>
<tr>
<td>pinned_archived_chat_count_max</td>
<td>Integer</td>
<td>No</td>
<td>Maximum number of pinned cloud chats in the Archive chat list. The same amount of secret chats can be pinned locally</td>
</tr>
<tr>
<td>pinned_chat_count_max</td>
<td>Integer</td>
<td>No</td>
<td>Maximum number of pinned cloud chats in the Main chat list. The same amount of secret chats can be pinned locally</td>
</tr>
<tr>
<td>photo_search_bot_username</td>
<td>String</td>
<td>No</td>
<td>Username of a bot which can be used in inline mode for photos search</td>
</tr>
<tr>
<td>replies_bot_chat_id</td>
<td>Integer</td>
<td>No</td>
<td>Identifier of the @replies bot</td>
</tr>
<tr>
<td>suggested_language_pack_id</td>
<td>String</td>
<td>No</td>
<td>Identifier of the language pack, suggested for the user by the server</td>
</tr>
<tr>
<td>suggested_video_note_audio_bitrate</td>
<td>Integer</td>
<td>No</td>
<td>Suggested bit rate for audio encoding in video notes, in kbit/s</td>
</tr>
<tr>
<td>suggested_video_note_length</td>
<td>Integer</td>
<td>No</td>
<td>Suggested width and height of the video in video notes</td>
</tr>
<tr>
<td>suggested_video_note_video_bitrate</td>
<td>Integer</td>
<td>No</td>
<td>Suggested bit rate for video encoding in video notes, in kbit/s</td>
</tr>
<tr>
<td>supergroup_size_max</td>
<td>Integer</td>
<td>No</td>
<td>Maximum number of members in a supergroup</td>
</tr>
<tr>
<td>t_me_url</td>
<td>String</td>
<td>No</td>
<td>Current value of t.me URL, i.e. <code>https://t.me/</code></td>
</tr>
<tr>
<td>telegram_service_notifications_chat_id</td>
<td>Integer</td>
<td>No</td>
<td>Identifier of the Telegram Service Notifications chat</td>
</tr>
<tr>
<td>test_mode</td>
<td>Boolean</td>
<td>No</td>
<td>If true, the test environment is being used instead of the production environment</td>
</tr>
<tr>
<td>unix_time</td>
<td>Integer</td>
<td>No</td>
<td>An estimation of the current Unix timestamp. The option will not be updated automatically unless the difference between the previous estimation and the locally available monotonic clocks changes significantly</td>
</tr>
<tr>
<td>venue_search_bot_username</td>
<td>String</td>
<td>No</td>
<td>Username of a bot which can be used in inline mode for venues search</td>
</tr>
<tr>
<td>version</td>
<td>String</td>
<td>No</td>
<td>TDLib version. This options is guaranteed to come before all other updates since TDLib 1.4.0</td>
</tr>
</tbody>
</table>
<p>Additionally any option beginning with 'x' or 'X' is writeable and can be safely used by the application to persistently store some small amount of data.</p>
</div>
</div>
</div>
</div>
<divclass="footer_wrap">
<divclass="footer_columns_wrap footer_desktop">
<divclass="footer_column footer_column_telegram">
<h5>Telegram</h5>
<divclass="footer_telegram_description"></div>
Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed.
