Update content of files

This commit is contained in:
GitHub Action 2024-07-08 17:35:36 +00:00
parent f080c6135d
commit 956927dda1
5 changed files with 140 additions and 16 deletions

View file

@ -49,11 +49,14 @@
<pre><code><a href='/constructor/config'>config</a>#cc1a241e flags:<a href='/type/%23'>#</a> default_p2p_contacts:flags.3?<a href='/constructor/true'>true</a> preload_featured_stickers:flags.4?<a href='/constructor/true'>true</a> revoke_pm_inbox:flags.6?<a href='/constructor/true'>true</a> blocked_mode:flags.8?<a href='/constructor/true'>true</a> force_try_ipv6:flags.14?<a href='/constructor/true'>true</a> date:<a href='/type/int'>int</a> expires:<a href='/type/int'>int</a> test_mode:<a href='/type/Bool'>Bool</a> this_dc:<a href='/type/int'>int</a> dc_options:<a href='/type/Vector%20t'>Vector</a>&lt;<a href='/type/DcOption'>DcOption</a>&gt; dc_txt_domain_name:<a href='/type/string'>string</a> chat_size_max:<a href='/type/int'>int</a> megagroup_size_max:<a href='/type/int'>int</a> forwarded_count_max:<a href='/type/int'>int</a> online_update_period_ms:<a href='/type/int'>int</a> offline_blur_timeout_ms:<a href='/type/int'>int</a> offline_idle_timeout_ms:<a href='/type/int'>int</a> online_cloud_timeout_ms:<a href='/type/int'>int</a> notify_cloud_delay_ms:<a href='/type/int'>int</a> notify_default_delay_ms:<a href='/type/int'>int</a> push_chat_period_ms:<a href='/type/int'>int</a> push_chat_limit:<a href='/type/int'>int</a> edit_time_limit:<a href='/type/int'>int</a> revoke_time_limit:<a href='/type/int'>int</a> revoke_pm_time_limit:<a href='/type/int'>int</a> rating_e_decay:<a href='/type/int'>int</a> stickers_recent_limit:<a href='/type/int'>int</a> channels_read_media_period:<a href='/type/int'>int</a> tmp_sessions:flags.0?<a href='/type/int'>int</a> call_receive_timeout_ms:<a href='/type/int'>int</a> call_ring_timeout_ms:<a href='/type/int'>int</a> call_connect_timeout_ms:<a href='/type/int'>int</a> call_packet_timeout_ms:<a href='/type/int'>int</a> me_url_prefix:<a href='/type/string'>string</a> autoupdate_url_prefix:flags.7?<a href='/type/string'>string</a> gif_search_username:flags.9?<a href='/type/string'>string</a> venue_search_username:flags.10?<a href='/type/string'>string</a> img_search_username:flags.11?<a href='/type/string'>string</a> static_maps_provider:flags.12?<a href='/type/string'>string</a> caption_length_max:<a href='/type/int'>int</a> message_length_max:<a href='/type/int'>int</a> webfile_dc_id:<a href='/type/int'>int</a> suggested_lang_code:flags.2?<a href='/type/string'>string</a> lang_pack_version:flags.2?<a href='/type/int'>int</a> base_lang_pack_version:flags.2?<a href='/type/int'>int</a> reactions_default:flags.15?<a href='/type/Reaction'>Reaction</a> autologin_token:flags.16?<a href='/type/string'>string</a> = <a href='/type/Config'>Config</a>;
<a href='/constructor/nearestDc'>nearestDc</a>#8e1a1775 country:<a href='/type/string'>string</a> this_dc:<a href='/type/int'>int</a> nearest_dc:<a href='/type/int'>int</a> = <a href='/type/NearestDc'>NearestDc</a>;
<a href='/constructor/updateConfig'>updateConfig</a>#a229dd06 = <a href='/type/Update'>Update</a>;
---functions---
<a href='/method/help.getConfig'>help.getConfig</a>#c4f9186b = <a href='/type/Config'>Config</a>;
<a href='/method/help.getNearestDc'>help.getNearestDc</a>#1fb33026 = <a href='/type/NearestDc'>NearestDc</a>;</code></pre>
<p>The huge <a href="/constructor/config">config</a> constructor contains lots of useful information, from chat and message size limitations, to privacy settings, online status refresh interval and timeout, VoIP configuration, default inline bot usernames for GIF, image and venue lookup, and lots of other global and user-specific information, check out the <a href="/constructor/config">constructor page</a> for more information.</p>
<p>The configuration should be manually refreshed immediately upon receival of an <a href="/method/updateConfig">updateConfig</a> update. </p>
<h3><a class="anchor" href="#client-configuration" id="client-configuration" name="client-configuration"><i class="anchor-icon"></i></a>Client configuration</h3>
<pre><code><a href='/constructor/jsonObjectValue'>jsonObjectValue</a>#c0de1bd9 key:<a href='/type/string'>string</a> value:<a href='/type/JSONValue'>JSONValue</a> = <a href='/type/JSONObjectValue'>JSONObjectValue</a>;
@ -67,12 +70,15 @@
<a href='/constructor/help.appConfigNotModified'>help.appConfigNotModified</a>#7cde641d = <a href='/type/help.AppConfig'>help.AppConfig</a>;
<a href='/constructor/help.appConfig'>help.appConfig</a>#dd18782e hash:<a href='/type/int'>int</a> config:<a href='/type/JSONValue'>JSONValue</a> = <a href='/type/help.AppConfig'>help.AppConfig</a>;
<a href='/constructor/updateConfig'>updateConfig</a>#a229dd06 = <a href='/type/Update'>Update</a>;
---functions---
<a href='/method/help.getAppConfig'>help.getAppConfig</a>#61e3f854 hash:<a href='/type/int'>int</a> = <a href='/type/help.AppConfig'>help.AppConfig</a>;</code></pre>
<p>The <a href="/method/help.getAppConfig">help.getAppConfig</a> method returns a JSON object containing rapidly evolving, client-specific configuration parameters.<br>
While <a href="/method/help.getConfig">help.getConfig</a> returns MTProto-specific configuration with information about server-side limitations and other MTProto-related information, <a href="/method/help.getAppConfig">help.getAppConfig</a> returns configuration parameters useful for graphical Telegram clients.</p>
<p>When first invoking <a href="/method/help.getAppConfig">help.getAppConfig</a>, pass <code>0</code> to hash; in future calls, use the <code>hash</code> contained in the previously returned <a href="/constructor/help.appConfig">help.appConfig</a>; if the configuration hasn't changed, a <a href="/constructor/help.appConfigNotModified">help.appConfigNotModified</a> will be returned instead of <a href="/constructor/help.appConfig">help.appConfig</a>.</p>
<p>The configuration should be manually refreshed immediately upon receival of an <a href="/method/updateConfig">updateConfig</a> update. </p>
<p>Example value of <a href="/constructor/help.appConfig">help.appConfig</a>.<code>config</code>: </p>
<pre><code class="language-json">{
"test": 1,
@ -591,9 +597,14 @@ A full list of these parameters can be seen in the <a href="#client-configuratio
<li><code>"VALIDATE_PHONE_NUMBER"</code> - Users should check whether their <a href="/api/auth">authorization phone number</a> is correct and change the phone number if it is inaccessible.</li>
<li><code>"NEWCOMER_TICKS"</code> - Show the user a hint about the meaning of one and two ticks on sent messages.</li>
<li><code>"SETUP_PASSWORD"</code> - Show the user a hint, asking them to check whether they still remember their <a href="/api/srp">2FA password</a></li>
<li><code>"PREMIUM_ANNUAL"</code> - Suggests the user to subscribe to the Premium subscription (with annual payments)</li>
<li><code>"PREMIUM_ANNUAL"</code> - Suggests the user to subscribe to Telegram Premium (with annual payments)</li>
<li><code>"PREMIUM_UPGRADE"</code> - Suggests the user to upgrade their existing Premium subscription from monthly payments to annual payments</li>
<li><code>"PREMIUM_RESTORE"</code> - Suggests the user to restore a recently expired Premium subscription</li>
<li><code>"PREMIUM_CHRISTMAS"</code> - Suggests the user to <a href="/api/premium#gifting-telegram-premium">gift Telegram Premium</a> subscription to friends for Christmas.</li>
<li><code>"PREMIUM_GRACE"</code> - Suggests the user to extend their expiring Telegram Premium subscription</li>
<li><code>"BIRTHDAY_SETUP"</code> - Suggests the user to set a <a href="/api/profile#birthday">birthday »</a>.</li>
<li><code>"BIRTHDAY_CONTACTS_TODAY"</code> - If set, indicates that the user has <strong>hidden</strong> the tooltip that recommends to gift a Telegram Premium subscription to contacts on their <a href="/api/profile#birthday">birthday »</a> (i.e. unlike the other suggestions, this is an inverted suggestion used to <em>hide</em> a tooltip, not display it).<br>
This suggestion can be <em>enabled</em> by invoking <a href="/method/help.dismissSuggestion">help.dismissSuggestion</a> when the user hides the tooltip, but it is also automatically enabled by the server if the user gifts one or more Telegram Premium subscriptions to friends with birthdays falling within the next/previous 24 hours. </li>
</ul>
</li>
</ul>

View file

@ -423,13 +423,6 @@
<h4><a class="anchor" href="#schema-changes" id="schema-changes" name="schema-changes"><i class="anchor-icon"></i></a>Schema changes</h4>
<h5><a class="anchor" href="#new-methods" id="new-methods" name="new-methods"><i class="anchor-icon"></i></a>New Methods</h5>
<ul>
<li>Added <a href="/method/smsjobs.isEligibleToJoin">smsjobs.isEligibleToJoin</a> - Check if we can process SMS jobs (official clients only).</li>
<li>Added <a href="/method/smsjobs.join">smsjobs.join</a> - Enable SMS jobs (official clients only).</li>
<li>Added <a href="/method/smsjobs.leave">smsjobs.leave</a> - Disable SMS jobs (official clients only).</li>
<li>Added <a href="/method/smsjobs.updateSettings">smsjobs.updateSettings</a> - Update SMS job settings (official clients only).</li>
<li>Added <a href="/method/smsjobs.getStatus">smsjobs.getStatus</a> - Get SMS jobs status (official clients only).</li>
<li>Added <a href="/method/smsjobs.getSmsJob">smsjobs.getSmsJob</a> - Get info about an SMS job (official clients only).</li>
<li>Added <a href="/method/smsjobs.finishJob">smsjobs.finishJob</a> - Finish an SMS job (official clients only).</li>
<li>Added <a href="/method/help.getTimezonesList">help.getTimezonesList</a> - Returns timezone information that may be used elsewhere in the API, such as to set <a href="/api/business#opening-hours">Telegram Business opening hours »</a>.</li>
<li>Added <a href="/method/account.updateBusinessWorkHours">account.updateBusinessWorkHours</a> - Specify a set of <a href="/api/business#opening-hours">Telegram Business opening hours</a>. </li>
<li>Added <a href="/method/account.updateBusinessLocation">account.updateBusinessLocation</a> - <a href="/api/business#location">Businesses »</a> may advertise their location using this method, see <a href="/api/business#location">here »</a> for more info.</li>
@ -459,10 +452,6 @@
</ul>
<h5><a class="anchor" href="#new-constructors" id="new-constructors" name="new-constructors"><i class="anchor-icon"></i></a>New Constructors</h5>
<ul>
<li>Added <a href="/constructor/smsjobs.eligibleToJoin">smsjobs.eligibleToJoin</a> - SMS jobs eligibility</li>
<li>Added <a href="/constructor/smsjobs.status">smsjobs.status</a> - Status</li>
<li>Added <a href="/constructor/updateSmsJob">updateSmsJob</a> - </li>
<li>Added <a href="/constructor/smsJob">smsJob</a> - Info about an SMS job.</li>
<li>Added <a href="/constructor/businessWeeklyOpen">businessWeeklyOpen</a> - A time interval, indicating the opening hours of a business.</li>
<li>Added <a href="/constructor/businessWorkHours">businessWorkHours</a> - Specifies a set of <a href="/api/business#opening-hours">Telegram Business opening hours</a>.</li>
<li>Added <a href="/constructor/businessLocation">businessLocation</a> - Represents the location of a <a href="/api/business#location">Telegram Business »</a>.</li>

View file

@ -144,14 +144,20 @@ Updating/reordering usernames will emit an <a href="/constructor/updateUserName"
<a href='/method/account.updateBirthday'>account.updateBirthday</a>#cc6e0c11 flags:<a href='/type/%23'>#</a> birthday:flags.0?<a href='/type/Birthday'>Birthday</a> = <a href='/type/Bool'>Bool</a>;
<a href='/method/contacts.getBirthdays'>contacts.getBirthdays</a>#daeda864 = <a href='/type/contacts.ContactBirthdays'>contacts.ContactBirthdays</a>;</code></pre>
<a href='/method/contacts.getBirthdays'>contacts.getBirthdays</a>#daeda864 = <a href='/type/contacts.ContactBirthdays'>contacts.ContactBirthdays</a>;
<a href='/method/help.dismissSuggestion'>help.dismissSuggestion</a>#f50dbaa1 peer:<a href='/type/InputPeer'>InputPeer</a> suggestion:<a href='/type/string'>string</a> = <a href='/type/Bool'>Bool</a>;</code></pre>
<p>Use <a href="/method/account.updateBirthday">account.updateBirthday</a> to set a birthday date that will be displayed to the users specified in the <a href="/api/privacy">privacy settings »</a>, according to the current privacy setting of <a href="/constructor/inputPrivacyKeyBirthday">inputPrivacyKeyBirthday</a> (only contacts by default). </p>
<p>The birthday (if accessible to the current user) will be present in <a href="/constructor/user">user</a>.<code>birthday</code>, changing it will emit an <a href="/constructor/updateUser">updateUser</a> update. </p>
<p>Setting the actual birth <code>year</code> is optional, and if set, the allowed age range is currently <code>0 &lt;= years &lt;= 150</code> (checked only when updating the birthday); a <code>400 BIRTHDAY_INVALID</code> error will be emitted otherwise. </p>
<p>To remove the birthday, call the method without setting the <code>birthday</code> flag. </p>
<p>The client should display a tooltip to set a birthday if the <code>BIRTHDAY_SETUP</code> <a href="/api/config#basic-suggestions">suggestion »</a> is returned by the server; this tooltip may be dismissed by the user, triggering a call to <a href="/method/help.dismissSuggestion">help.dismissSuggestion</a> with suggestion=<code>BIRTHDAY_SETUP</code> to sync the state on all currently logged-in clients. </p>
<p><a href="/method/contacts.getBirthdays">contacts.getBirthdays</a> returns all users with birthdays that fall within +1/-1 days, relative to the current day: this method should be invoked by clients every 6-8 hours, and if the result is non-empty, it should be used to appropriately update locally cached birthday information in <a href="/constructor/user">user</a>.<code>birthday</code>. </p>
<p>All <em>contacts</em> whose <a href="/constructor/user">user</a>.<code>birthday</code> fields (updated through <a href="/method/contacts.getBirthdays">contacts.getBirthdays</a> and in other ways, i.e. through <a href="/constructor/updateUser">updateUser</a> updates) fall within +1/-1 days relative to today should be always listed in an action bar shown in the global dialog list (<em>not</em> the user-specific <a href="/api/action-bar">action bar »</a>), inviting the user to make a birthday <a href="/api/premium#gifting-telegram-premium">gift to those users, in the form of one or more Telegram Premium subscriptions »</a>. </p>
<p>Additionally, if a user has a birthday falling within the specified time range (+1/-1 days) as specified in <a href="/constructor/user">user</a>.<code>birthday</code>, a gift icon tooltip should be shown in the text input bar in private chats with them, leading to the <a href="/api/premium#gifting-telegram-premium">Telegram Premium gift flow »</a> (this also applies to non-contacts that have allowed us to see their birthday date). </p>
<p>If and only if the <code>BIRTHDAY_CONTACTS_TODAY</code> <a href="/api/config#suggestions">suggestion »</a> is <strong>not</strong> set, all <em>contacts</em> whose <a href="/constructor/user">user</a>.<code>birthday</code> fields (updated through <a href="/method/contacts.getBirthdays">contacts.getBirthdays</a> and in other ways, i.e. through <a href="/constructor/updateUser">updateUser</a> updates) fall within +1/-1 days relative to today should be always listed in an action bar shown in the global dialog list (<em>not</em> the user-specific <a href="/api/action-bar">action bar »</a>), inviting the user to make a birthday <a href="/api/premium#gifting-telegram-premium">gift to those users, in the form of one or more Telegram Premium subscriptions »</a>. </p>
<p>The birthday action bar may be dismissed by the user, syncing its state to other currently logged-in sessions by invoking <a href="/method/help.dismissSuggestion">help.dismissSuggestion</a> with suggestion=<code>BIRTHDAY_CONTACTS_TODAY</code>.<br>
Since <code>BIRTHDAY_CONTACTS_TODAY</code> is an <em>inverted</em> suggestion, dismissing it will actually <em>enable</em> it in the <a href="/api/config#client-configuration">client configuration</a> on all currently logged-in sessions, notified by an <a href="/constructor/updateConfig">updateConfig</a>, and its <em>presence</em> should be treated as a signal to <em>not</em> display the birthday action bar. </p>
<p>The suggestion is also automatically enabled by the server if the user gifts one or more Telegram Premium subscriptions to friends with birthdays falling within the next/previous 24 hours, thus hiding the birthday action bar to other logged-in sessions. </p>
<p>Additionally, if a user has a birthday falling within the specified time range (+1/-1 days) as specified in <a href="/constructor/user">user</a>.<code>birthday</code>, a gift icon tooltip should be shown in the text input bar in private chats with them, leading to the <a href="/api/premium#gifting-telegram-premium">Telegram Premium gift flow »</a> (this also applies to non-contacts that have allowed us to see their birthday date), regardless of the presence or absence of <code>BIRTHDAY_CONTACTS_TODAY</code>. </p>
<h3><a class="anchor" href="#personal-channel" id="personal-channel" name="personal-channel"><i class="anchor-icon"></i></a>Personal channel</h3>
<pre><code><a href='/constructor/inputChannel'>inputChannel</a>#f35aec28 channel_id:<a href='/type/long'>long</a> access_hash:<a href='/type/long'>long</a> = <a href='/type/InputChannel'>InputChannel</a>;
<a href='/constructor/inputChannelEmpty'>inputChannelEmpty</a>#ee8c1e86 = <a href='/type/InputChannel'>InputChannel</a>;

View file

@ -42,7 +42,7 @@
<div class="dev_page_bread_crumbs"><ul class="breadcrumb clearfix"><li><a href="/api" >API</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/schema" >TL-schema</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/constructor/updateConfig" >updateConfig</a></li></ul></div>
<h1 id="dev_page_title">updateConfig</h1>
<div id="dev_page_content"><p>The server-side configuration has changed; the client should re-fetch the config using <a href="/method/help.getConfig">help.getConfig</a></p>
<div id="dev_page_content"><p>The server-side configuration has changed; the client should re-fetch the config using <a href="/method/help.getConfig">help.getConfig</a> and <a href="/method/help.getAppConfig">help.getAppConfig</a>. </p>
<p><div class="clearfix">
<ul class="dev_layer_select slightly-pull-right nav nav-pills">
<li class="dropdown">

View file

@ -0,0 +1,118 @@
<!DOCTYPE html>
<html class="">
<head>
<meta charset="utf-8">
<title>Page not found</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta property="description" content="">
<meta property="og:title" content="Page not found">
<meta property="og:image" content="">
<meta property="og:description" content="">
<link rel="icon" type="image/svg+xml" href="/img/website_icon.svg?4">
<link rel="apple-touch-icon" sizes="180x180" href="/img/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/img/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="/img/favicon-16x16.png">
<link rel="alternate icon" href="/img/favicon.ico" type="image/x-icon" />
<link href="/css/bootstrap.min.css?3" rel="stylesheet">
<link href="/css/telegram.css?239" rel="stylesheet" media="screen">
<style>
</style>
</head>
<body class="preload">
<div class="dev_page_wrap">
<div class="dev_page_head navbar navbar-static-top navbar-tg">
<div class="navbar-inner">
<div class="container clearfix">
<ul class="nav navbar-nav navbar-right hidden-xs"><li class="navbar-twitter"><a href="https://twitter.com/telegram" target="_blank" data-track="Follow/Twitter" onclick="trackDlClick(this, event)"><i class="icon icon-twitter"></i><span> Twitter</span></a></li></ul>
<ul class="nav navbar-nav">
<li><a href="//telegram.org/">Home</a></li>
<li class="hidden-xs"><a href="//telegram.org/faq">FAQ</a></li>
<li class="hidden-xs"><a href="//telegram.org/apps">Apps</a></li>
<li class="active"><a href="/api">API</a></li>
<li class=""><a href="/mtproto">Protocol</a></li>
<li class=""><a href="/schema">Schema</a></li>
</ul>
</div>
</div>
</div>
<div class="container clearfix">
<div class="dev_page">
<div id="dev_page_content_wrap" class=" ">
<div class="dev_page_bread_crumbs"><ul class="breadcrumb clearfix"><li><a href="/api" >API</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/methods" >All Methods</a></li><i class="icon icon-breadcrumb-divider"></i><li></li></ul></div>
<h1 id="dev_page_title">Page not found</h1>
<div id="dev_page_content">The page has not been saved</div>
</div>
</div>
</div>
<div class="footer_wrap">
<div class="footer_columns_wrap footer_desktop">
<div class="footer_column footer_column_telegram">
<h5>Telegram</h5>
<div class="footer_telegram_description"></div>
Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed.
</div>
<div class="footer_column">
<h5><a href="//telegram.org/faq">About</a></h5>
<ul>
<li><a href="//telegram.org/faq">FAQ</a></li>
<li><a href="//telegram.org/privacy">Privacy</a></li>
<li><a href="//telegram.org/press">Press</a></li>
</ul>
</div>
<div class="footer_column">
<h5><a href="//telegram.org/apps#mobile-apps">Mobile Apps</a></h5>
<ul>
<li><a href="//telegram.org/dl/ios">iPhone/iPad</a></li>
<li><a href="//telegram.org/android">Android</a></li>
<li><a href="//telegram.org/dl/web">Mobile Web</a></li>
</ul>
</div>
<div class="footer_column">
<h5><a href="//telegram.org/apps#desktop-apps">Desktop Apps</a></h5>
<ul>
<li><a href="//desktop.telegram.org/">PC/Mac/Linux</a></li>
<li><a href="//macos.telegram.org/">macOS</a></li>
<li><a href="//telegram.org/dl/web">Web-browser</a></li>
</ul>
</div>
<div class="footer_column footer_column_platform">
<h5><a href="//core.telegram.org/">Platform</a></h5>
<ul>
<li><a href="//core.telegram.org/api">API</a></li>
<li><a href="//translations.telegram.org/">Translations</a></li>
<li><a href="//instantview.telegram.org/">Instant View</a></li>
</ul>
</div>
</div>
<div class="footer_columns_wrap footer_mobile">
<div class="footer_column">
<h5><a href="//telegram.org/faq">About</a></h5>
</div>
<div class="footer_column">
<h5><a href="//telegram.org/blog">Blog</a></h5>
</div>
<div class="footer_column">
<h5><a href="//telegram.org/apps">Apps</a></h5>
</div>
<div class="footer_column">
<h5><a href="//core.telegram.org/">Platform</a></h5>
</div>
<div class="footer_column">
<h5><a href="//telegram.org/press">Press</a></h5>
</div>
</div>
</div>
</div>
<script src="/js/main.js?47"></script>
<script>backToTopInit("Go up");
removePreloadInit();
</script>
</body>
</html>