MadelineProtoDocs/docs/API_docs/constructors/botInlineMessageMediaWebPage.md
2024-05-01 14:53:46 +02:00

4.3 KiB

title description nav_exclude image
botInlineMessageMediaWebPage Specifies options that must be used to generate the link preview for the message, or even a standalone link preview without an attached message. true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: botInlineMessageMediaWebPage

Back to constructors index

Specifies options that must be used to generate the link preview for the message, or even a standalone link preview without an attached message.

Attributes:

Name Type Required Description
invert_media Bool Optional If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.
force_large_media Bool Optional If set, specifies that a large media preview should be used.
force_small_media Bool Optional If set, specifies that a small media preview should be used.
manual Bool Optional If set, indicates that the URL used for the webpage preview was specified manually using inputMediaWebPage, and may not be related to any of the URLs specified in the message.
safe Bool Optional If set, the link can be opened directly without user confirmation.
message string Yes The message, can be empty.
entities Array of MessageEntity Optional Message entities for styled text
parse_mode string Whether to parse HTML or Markdown markup in the message Optional
url string Yes The URL to use for the link preview.
reply_markup ReplyMarkup Optional Reply markup for sending bot buttons

Type: BotInlineMessage

Usage of parse_mode:

Set parse_mode to html to enable HTML parsing of the message.

Set parse_mode to Markdown to enable markdown parsing of the message.

The following tags are currently supported:

<br>a newline
<b><i>bold works ok, internal tags are stripped</i> </b>
<strong>bold</strong>
<em>italic</em>
<i>italic</i>
<u>underline</u>
<s>strikethrough</s>
<del>strikethrough</del>
<strike>strikethrough</strike>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
<blockquote>pre-formatted fixed-width code block</blockquote>
<a href="https://github.com">URL</a>
<a href="mention:@danogentili">Mention by username</a>
<a href="mention:186785362">Mention by user id</a>
<a href="tg://user?id=186785362">Mention by user id</a>
Custom emoji: <emoji id="5368324170671202286">👍</emoji>
Custom emoji: <tg-emoji emoji-id="5368324170671202286">👍</tg-emoji>
<pre language="json">Pre tags can have a language attribute</pre>
<spoiler>Spoiler</spoiler>
<tg-spoiler>Spoiler</tg-spoiler>

You can also use normal markdown (bot API MarkdownV2 syntax), note that to create mentions you can also use the mention: syntax like in html:

*bold \*text*
_italic \*text_
__underline__
~strikethrough~
||spoiler||
*bold _italic bold ~italic bold strikethrough ||italic bold strikethrough spoiler||~ __underline italic bold___ bold*
[inline URL](http://www.example.com/)
[inline mention of a user](tg://user?id=123456789)
![👍](tg://emoji?id=5368324170671202286)
\`inline fixed-width code\`
\`\`\`
pre-formatted fixed-width code block
\`\`\`
\`\`\`php
pre-formatted fixed-width code block written in the PHP programming language
\`\`\`

[Mention by username](mention:@danogentili)
[Mention by user id](mention:186785362)
[Mention by user id](tg://user?id=186785362)
[👍](emoji:5368324170671202286)
[👍](tg://emoji?id=5368324170671202286)

Example:

$botInlineMessageMediaWebPage = ['_' => 'botInlineMessageMediaWebPage', 'invert_media' => Bool, 'force_large_media' => Bool, 'force_small_media' => Bool, 'manual' => Bool, 'safe' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]parse_mode: 'string', , 'url' => 'string', 'reply_markup' => ReplyMarkup];