MadelineProtoDocs/old_docs/API_docs_v73/constructors/config.md
2019-12-27 17:48:04 +01:00

6.9 KiB

title description image
config Current configuration https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: config

Back to constructors index

Current configuration

Attributes:

Name Type Required Description
phonecalls_enabled Bool Optional Whether phone calls can be used
default_p2p_contacts Bool Optional Whether the client should use P2P by default for phone calls with contacts
date int Yes Current date at the server
expires int Yes Expiration date of this config: when it expires it'll have to be refetched using help.getConfig
test_mode Bool Yes Whether we're connected to the test DCs
this_dc int Yes ID of the DC that returned the reply
dc_options Array of DcOption Yes DC options
chat_size_max int Yes Maximum member count for normal groups
megagroup_size_max int Yes Maximum member count for supergroups
forwarded_count_max int Yes Maximum number of messages that can be forwarded at once using messages.forwardMessages.
online_update_period_ms int Yes The client should update its online status every N milliseconds
offline_blur_timeout_ms int Yes Delay before offline status needs to be sent to the server
offline_idle_timeout_ms int Yes Time without any user activity after which it should be treated offline
online_cloud_timeout_ms int Yes If 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_ms int Yes If we are offline, but online from some other client then delay sending the offline notification for notify_cloud_delay_ms milliseconds.
notify_default_delay_ms int Yes If some other client is online, then delay notification for notification_default_delay_ms milliseconds
chat_big_size int Yes Chat big size
push_chat_period_ms int Yes Not for client use
push_chat_limit int Yes Not for client use
saved_gifs_limit int Yes Maximum count of saved gifs
edit_time_limit int Yes Only messages with age smaller than the one specified can be edited
rating_e_decay int Yes Exponential decay rate for computing top peer rating
stickers_recent_limit int Yes Maximum number of recent stickers
stickers_faved_limit int Yes Maximum number of faved stickers
channels_read_media_period int Yes Indicates that round videos (video notes) and voice messages sent in channels and older than the specified period must be marked as read
tmp_sessions int Optional Temporary passport sessions
pinned_dialogs_count_max int Yes Maximum count of pinned dialogs
call_receive_timeout_ms int Yes Maximum 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_ms int Yes Maximum 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_ms int Yes VoIP 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_ms int Yes If during a VoIP call a packet isn't received for the specified period of time, the call must be aborted
me_url_prefix string Yes The domain to use to parse in-app links.
For example t.me indicates that t.me/username links should parsed to @username, t.me/addsticker/name should be parsed to the appropriate stickerset and so on...
suggested_lang_code string Optional Suggested language code
lang_pack_version int Optional Language pack version
disabled_features Array of DisabledFeature Yes Disabled features

Type: Config

Example:

$config = ['_' => 'config', 'phonecalls_enabled' => Bool, 'default_p2p_contacts' => Bool, 'date' => int, 'expires' => int, 'test_mode' => Bool, 'this_dc' => int, 'dc_options' => [DcOption, DcOption], '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, 'chat_big_size' => int, 'push_chat_period_ms' => int, 'push_chat_limit' => int, 'saved_gifs_limit' => int, 'edit_time_limit' => int, 'rating_e_decay' => int, 'stickers_recent_limit' => int, 'stickers_faved_limit' => int, 'channels_read_media_period' => int, 'tmp_sessions' => int, 'pinned_dialogs_count_max' => 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', 'suggested_lang_code' => 'string', 'lang_pack_version' => int, 'disabled_features' => [DisabledFeature, DisabledFeature]];

Or, if you're into Lua:

config={_='config', phonecalls_enabled=Bool, default_p2p_contacts=Bool, date=int, expires=int, test_mode=Bool, this_dc=int, dc_options={DcOption}, 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, chat_big_size=int, push_chat_period_ms=int, push_chat_limit=int, saved_gifs_limit=int, edit_time_limit=int, rating_e_decay=int, stickers_recent_limit=int, stickers_faved_limit=int, channels_read_media_period=int, tmp_sessions=int, pinned_dialogs_count_max=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', suggested_lang_code='string', lang_pack_version=int, disabled_features={DisabledFeature}}