mirror of
https://github.com/danog/MadelineProtoDocs.git
synced 2024-12-04 02:28:31 +01:00
93 lines
3.2 KiB
Markdown
93 lines
3.2 KiB
Markdown
---
|
|
title: "inputSingleMedia"
|
|
description: "A single media in an album or grouped media sent with messages.sendMultiMedia."
|
|
nav_exclude: true
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|
---
|
|
# Constructor: inputSingleMedia
|
|
[Back to constructors index](/API_docs/constructors/index.html)
|
|
|
|
|
|
|
|
A single media in an [album or grouped media](https://core.telegram.org/api/files#albums-grouped-media) sent with [messages.sendMultiMedia](../methods/messages.sendMultiMedia.html).
|
|
|
|
### Attributes:
|
|
|
|
| Name | Type | Required | Description |
|
|
|----------|---------------|----------|-------------|
|
|
|media|[MessageMedia, Message, Update or InputMedia](/API_docs/types/InputMedia.html) | Optional|The media|
|
|
|message|[string](/API_docs/types/string.html) | Yes|A caption for the media|
|
|
|entities|Array of [MessageEntity](/API_docs/types/MessageEntity.html) | Optional|Message [entities](https://core.telegram.org/api/entities) for styled text|
|
|
|parse\_mode| [string](/API_docs/types/string.html) | Whether to parse HTML or Markdown markup in the message| Optional |
|
|
|
|
|
|
|
|
### Type: [InputSingleMedia](/API_docs/types/InputSingleMedia.html)
|
|
|
|
|
|
|
|
## 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:
|
|
|
|
```html
|
|
<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](https://core.telegram.org/bots/api#markdownv2-style)), note that to create mentions you can also use the `mention:` syntax like in html:
|
|
|
|
```markdown
|
|
*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)
|
|
|
|
\`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:
|
|
|
|
```
|
|
$inputSingleMedia = ['_' => 'inputSingleMedia', 'media' => InputMedia, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]parse_mode: 'string', ];
|
|
```
|