4.3 KiB
| title | description | nav_exclude | image |
|---|---|---|---|
| updateServiceNotification | A service message for the user. | true | https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png |
Constructor: updateServiceNotification
A service message for the user.
The app must show the message to the user upon receiving this update. In case the popup parameter was passed, the text message must be displayed in a popup alert immediately upon receipt. It is recommended to handle the text as you would an ordinary message in terms of highlighting links, etc. The message must also be stored locally as part of the message history with the user id 777000 (Telegram Notifications).
Attributes:
| Name | Type | Required | Description |
|---|---|---|---|
| popup | Bool | Optional | If set, the message must be displayed in a popup. |
| invert_media | Bool | Optional | If set, any eventual webpage preview will be shown on top of the message instead of at the bottom. |
| inbox_date | int | Optional | When was the notification received The message must also be stored locally as part of the message history with the user id 777000 (Telegram Notifications). |
| type | string | Yes | String, identical in format and contents to the type field in API errors. Describes type of service message. It is acceptable to ignore repeated messages of the same type within a short period of time (15 minutes). |
| message | string | Yes | Message text |
| media | MessageMedia | Optional | Media content (optional) |
| entities | Array of MessageEntity | Yes | Message entities for styled text |
| parse_mode | string | Whether to parse HTML or Markdown markup in the message | Optional |
Type: Update
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)
\`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:
$updateServiceNotification = ['_' => 'updateServiceNotification', 'popup' => Bool, 'invert_media' => Bool, 'inbox_date' => int, 'type' => 'string', 'message' => 'string', 'media' => MessageMedia, 'entities' => [MessageEntity, MessageEntity]parse_mode: 'string', ];