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

4.7 KiB

title description nav_exclude image
updateShortMessage Info about a message sent to (received from) another user true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: updateShortMessage

Back to constructors index

Info about a message sent to (received from) another user

Attributes:

Name Type Required Description
out Bool Optional Whether the message is outgoing
mentioned Bool Optional Whether we were mentioned in the message
media_unread Bool Optional Whether there are some unread mentions in this message
silent Bool Optional If true, the message is a silent message, no notifications should be triggered
id int Yes The message ID
user_id long Yes The ID of the sender (if outgoing will be the ID of the destination) of the message
message string Yes The message
pts int Yes PTS
pts_count int Yes PTS count
date int Yes date
fwd_from MessageFwdHeader Optional Info about a forwarded message
via_bot_id long Optional Info about the inline bot used to generate this message
reply_to MessageReplyHeader Optional Reply and thread information
entities Array of MessageEntity Optional Entities for styled text
parse_mode string Whether to parse HTML or Markdown markup in the message Optional
ttl_period int Optional Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well.

Type: Updates

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:

$updateShortMessage = ['_' => 'updateShortMessage', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'id' => int, 'user_id' => long, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => long, 'reply_to' => MessageReplyHeader, 'entities' => [MessageEntity, MessageEntity]parse_mode: 'string', , 'ttl_period' => int];