Link Search Menu Expand Document

Constructor: config

Back to constructors index

Current configuration

Attributes:

NameTypeRequiredDescription
default_p2p_contactsBoolOptionalWhether the client should use P2P by default for phone calls with contacts
preload_featured_stickersBoolOptionalWhether the client should preload featured stickers
revoke_pm_inboxBoolOptionalWhether incoming private messages can be deleted for both participants
blocked_modeBoolOptionalIndicates that telegram is probably censored by governments/ISPs in the current region
force_try_ipv6BoolOptionalWhether to forcefully connect using IPv6 dcOptions, even if the client knows that IPv4 is available.
dateintYesCurrent date at the server
expiresintYesExpiration date of this config: when it expires it’ll have to be refetched using help.getConfig
test_modeBoolYesWhether we’re connected to the test DCs
this_dcintYesID of the DC that returned the reply
dc_optionsArray of DcOptionYesDC IP list
dc_txt_domain_namestringYesDomain name for fetching encrypted DC list from DNS TXT record
chat_size_maxintYesMaximum member count for normal groups
megagroup_size_maxintYesMaximum member count for supergroups
forwarded_count_maxintYesMaximum number of messages that can be forwarded at once using messages.forwardMessages.
online_update_period_msintYesThe client should update its online status every N milliseconds
offline_blur_timeout_msintYesDelay before offline status needs to be sent to the server
offline_idle_timeout_msintYesTime without any user activity after which it should be treated offline
online_cloud_timeout_msintYesIf we are offline, but were online from some other client in last online_cloud_timeout_ms milliseconds after we had gone offline, then delay offline notification for notify_cloud_delay_ms milliseconds.
notify_cloud_delay_msintYesIf we are offline, but online from some other client then delay sending the offline notification for notify_cloud_delay_ms milliseconds.
notify_default_delay_msintYesIf some other client is online, then delay notification for notification_default_delay_ms milliseconds
push_chat_period_msintYesNot for client use
push_chat_limitintYesNot for client use
edit_time_limitintYesOnly messages with age smaller than the one specified can be edited
revoke_time_limitintYesOnly channel/supergroup messages with age smaller than the specified can be deleted
revoke_pm_time_limitintYesOnly private messages with age smaller than the specified can be deleted
rating_e_decayintYesExponential decay rate for computing top peer rating
stickers_recent_limitintYesMaximum number of recent stickers
channels_read_media_periodintYesIndicates that round videos (video notes) and voice messages sent in channels and older than the specified period must be marked as read
tmp_sessionsintOptionalTemporary passport sessions
call_receive_timeout_msintYesMaximum allowed outgoing ring time in VoIP calls: if the user we’re calling doesn’t reply within the specified time (in milliseconds), we should hang up the call
call_ring_timeout_msintYesMaximum allowed incoming ring time in VoIP calls: if the current user doesn’t reply within the specified time (in milliseconds), the call will be automatically refused
call_connect_timeout_msintYesVoIP connection timeout: if the instance of libtgvoip on the other side of the call doesn’t connect to our instance of libtgvoip within the specified time (in milliseconds), the call must be aborted
call_packet_timeout_msintYesIf during a VoIP call a packet isn’t received for the specified period of time, the call must be aborted
me_url_prefixstringYesThe domain to use to parse deep links ».
autoupdate_url_prefixstringOptionalURL to use to auto-update the current app
gif_search_usernamestringOptionalUsername of the bot to use to search for GIFs
venue_search_usernamestringOptionalUsername of the bot to use to search for venues
img_search_usernamestringOptionalUsername of the bot to use for image search
static_maps_providerstringOptionalID of the map provider to use for venues
caption_length_maxintYesMaximum length of caption (length in utf8 codepoints)
message_length_maxintYesMaximum length of messages (length in utf8 codepoints)
webfile_dc_idintYesDC ID to use to download webfiles
suggested_lang_codestringOptionalSuggested language code
lang_pack_versionintOptionalLanguage pack version
base_lang_pack_versionintOptionalBasic language pack version
reactions_defaultReactionOptionalDefault message reaction
autologin_tokenstringOptionalAutologin token, click here for more info on URL authorization ».

Type: Config

Example:

$config = ['_' => 'config', 'default_p2p_contacts' => Bool, 'preload_featured_stickers' => Bool, 'revoke_pm_inbox' => Bool, 'blocked_mode' => Bool, 'force_try_ipv6' => Bool, 'date' => int, 'expires' => int, 'test_mode' => Bool, 'this_dc' => int, 'dc_options' => [DcOption, DcOption], 'dc_txt_domain_name' => 'string', 'chat_size_max' => int, 'megagroup_size_max' => int, 'forwarded_count_max' => int, 'online_update_period_ms' => int, 'offline_blur_timeout_ms' => int, 'offline_idle_timeout_ms' => int, 'online_cloud_timeout_ms' => int, 'notify_cloud_delay_ms' => int, 'notify_default_delay_ms' => int, 'push_chat_period_ms' => int, 'push_chat_limit' => int, 'edit_time_limit' => int, 'revoke_time_limit' => int, 'revoke_pm_time_limit' => int, 'rating_e_decay' => int, 'stickers_recent_limit' => int, 'channels_read_media_period' => int, 'tmp_sessions' => int, 'call_receive_timeout_ms' => int, 'call_ring_timeout_ms' => int, 'call_connect_timeout_ms' => int, 'call_packet_timeout_ms' => int, 'me_url_prefix' => 'string', 'autoupdate_url_prefix' => 'string', 'gif_search_username' => 'string', 'venue_search_username' => 'string', 'img_search_username' => 'string', 'static_maps_provider' => 'string', 'caption_length_max' => int, 'message_length_max' => int, 'webfile_dc_id' => int, 'suggested_lang_code' => 'string', 'lang_pack_version' => int, 'base_lang_pack_version' => int, 'reactions_default' => Reaction, 'autologin_token' => 'string'];