Skip to content

Commit

Permalink
docs: staging: Update docs 2024-01-03 | 21:01:05 PM UTC
Browse files Browse the repository at this point in the history
Signed-off-by: Mayuri-Chan <[email protected]>
  • Loading branch information
Mayuri-Chan committed Jan 3, 2024
1 parent 3acc679 commit 60a184b
Show file tree
Hide file tree
Showing 147 changed files with 379 additions and 203 deletions.
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.copy.html
Original file line number Diff line number Diff line change
Expand Up @@ -1952,7 +1952,8 @@ <h1 id="message-copy">Message.copy()<a class="headerlink" href="#message-copy" t
<dd class="field-odd"><ul class="simple">
<li><p><strong>chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code> | <code class="docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use “me” or “self”.
For a contact that exists in your Telegram address book you can use his phone number (str).</p></li>
For a contact that exists in your Telegram address book you can use his phone number (str).
You can also use chat public link in form of <em>t.me/&lt;username&gt;</em> (str).</p></li>
<li><p><strong>caption</strong> (<code class="docutils literal notranslate"><span class="pre">string</span></code>, <em>optional</em>) – New caption for media, 0-1024 characters after entities parsing.
If not specified, the original caption is kept.
Pass “” (empty string) to remove the caption.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.forward.html
Original file line number Diff line number Diff line change
Expand Up @@ -1952,7 +1952,8 @@ <h1 id="message-forward">Message.forward()<a class="headerlink" href="#message-f
<dd class="field-odd"><ul class="simple">
<li><p><strong>chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code> | <code class="docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use “me” or “self”.
For a contact that exists in your Telegram address book you can use his phone number (str).</p></li>
For a contact that exists in your Telegram address book you can use his phone number (str).
You can also use chat public link in form of <em>t.me/&lt;username&gt;</em> (str).</p></li>
<li><p><strong>message_thread_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of a message thread to which the message belongs; for supergroups only</p></li>
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
Expand Down
5 changes: 3 additions & 2 deletions staging/api/bound-methods/Message.reply.html
Original file line number Diff line number Diff line change
Expand Up @@ -1962,8 +1962,9 @@ <h1 id="message-reply">Message.reply()<a class="headerlink" href="#message-reply
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>reply_to_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code> | <code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Unique identifier for the origin chat.
for reply to message from another chat.
You can also use chat public link in form of <em>t.me/&lt;username&gt;</em> (str).</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
<li><p><strong>quote_entities</strong> (List of <a class="reference internal" href="../types/MessageEntity.html#pyrogram.types.MessageEntity" title="pyrogram.types.MessageEntity (Python class) — One special entity in a text message."><code class="xref py py-obj docutils literal notranslate"><span class="pre">MessageEntity</span></code></a>, <em>optional</em>) – List of special entities that appear in quote_text, which can be specified instead of <em>parse_mode</em>.
Expand Down
5 changes: 3 additions & 2 deletions staging/api/bound-methods/Message.reply_animation.html
Original file line number Diff line number Diff line change
Expand Up @@ -1987,8 +1987,9 @@ <h1 id="message-reply-animation">Message.reply_animation()<a class="headerlink"
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>reply_to_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code> | <code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Unique identifier for the origin chat.
for reply to message from another chat.
You can also use chat public link in form of <em>t.me/&lt;username&gt;</em> (str).</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
<li><p><strong>quote_entities</strong> (List of <a class="reference internal" href="../types/MessageEntity.html#pyrogram.types.MessageEntity" title="pyrogram.types.MessageEntity (Python class) — One special entity in a text message."><code class="xref py py-obj docutils literal notranslate"><span class="pre">MessageEntity</span></code></a>, <em>optional</em>) – List of special entities that appear in quote_text, which can be specified instead of <em>parse_mode</em>.
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_audio.html
Original file line number Diff line number Diff line change
Expand Up @@ -1986,7 +1986,8 @@ <h1 id="message-reply-audio">Message.reply_audio()<a class="headerlink" href="#m
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_cached_media.html
Original file line number Diff line number Diff line change
Expand Up @@ -1961,7 +1961,8 @@ <h1 id="message-reply-cached-media">Message.reply_cached_media()<a class="header
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_contact.html
Original file line number Diff line number Diff line change
Expand Up @@ -1960,7 +1960,8 @@ <h1 id="message-reply-contact">Message.reply_contact()<a class="headerlink" href
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_document.html
Original file line number Diff line number Diff line change
Expand Up @@ -1986,7 +1986,8 @@ <h1 id="message-reply-document">Message.reply_document()<a class="headerlink" hr
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_location.html
Original file line number Diff line number Diff line change
Expand Up @@ -1958,7 +1958,8 @@ <h1 id="message-reply-location">Message.reply_location()<a class="headerlink" hr
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_media_group.html
Original file line number Diff line number Diff line change
Expand Up @@ -1958,7 +1958,8 @@ <h1 id="message-reply-media-group">Message.reply_media_group()<a class="headerli
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_photo.html
Original file line number Diff line number Diff line change
Expand Up @@ -1981,7 +1981,8 @@ <h1 id="message-reply-photo">Message.reply_photo()<a class="headerlink" href="#m
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_poll.html
Original file line number Diff line number Diff line change
Expand Up @@ -1980,7 +1980,8 @@ <h1 id="message-reply-poll">Message.reply_poll()<a class="headerlink" href="#mes
Users will receive a notification with no sound.</p></li>
<li><p><strong>protect_content</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Protects the contents of the sent message from forwarding and saving.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_sticker.html
Original file line number Diff line number Diff line change
Expand Up @@ -1973,7 +1973,8 @@ <h1 id="message-reply-sticker">Message.reply_sticker()<a class="headerlink" href
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
5 changes: 3 additions & 2 deletions staging/api/bound-methods/Message.reply_text.html
Original file line number Diff line number Diff line change
Expand Up @@ -1962,8 +1962,9 @@ <h1 id="message-reply-text">Message.reply_text()<a class="headerlink" href="#mes
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>reply_to_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code> | <code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Unique identifier for the origin chat.
for reply to message from another chat.
You can also use chat public link in form of <em>t.me/&lt;username&gt;</em> (str).</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
<li><p><strong>quote_entities</strong> (List of <a class="reference internal" href="../types/MessageEntity.html#pyrogram.types.MessageEntity" title="pyrogram.types.MessageEntity (Python class) — One special entity in a text message."><code class="xref py py-obj docutils literal notranslate"><span class="pre">MessageEntity</span></code></a>, <em>optional</em>) – List of special entities that appear in quote_text, which can be specified instead of <em>parse_mode</em>.
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_venue.html
Original file line number Diff line number Diff line change
Expand Up @@ -1965,7 +1965,8 @@ <h1 id="message-reply-venue">Message.reply_venue()<a class="headerlink" href="#m
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
3 changes: 2 additions & 1 deletion staging/api/bound-methods/Message.reply_video.html
Original file line number Diff line number Diff line change
Expand Up @@ -1991,7 +1991,8 @@ <h1 id="message-reply-video">Message.reply_video()<a class="headerlink" href="#m
<li><p><strong>disable_notification</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>, <em>optional</em>) – Sends the message silently.
Users will receive a notification with no sound.</p></li>
<li><p><strong>reply_to_message_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – If the message is a reply, ID of the original message.</p></li>
<li><p><strong>reply_in_chat_id</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>, <em>optional</em>) – Unique identifier of target chat.
<li><p><strong>reply_in_chat_id</strong> – Union[int, str] = None,
Unique identifier of target chat.
for reply message in another chat.</p></li>
<li><p><strong>quote_text</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>, <em>optional</em>) – Text to quote.
for reply_to_message only.</p></li>
Expand Down
Loading

0 comments on commit 60a184b

Please sign in to comment.