5 Commits

Author SHA1 Message Date
renovate[bot]
de16a19d65 Update dependency mkdocs-mermaid2-plugin to v1.2.3 2026-05-02 00:01:58 +00:00
72aece1cf4 fix of Message hierarchy 2026-04-30 11:23:10 +06:00
7c6e8ac655 fix messages hierarchy showing 2026-04-29 20:59:17 +06:00
446c6d7516 add updates section 2026-04-29 20:59:17 +06:00
b64117f829 Update index.md 2026-04-25 12:33:36 +06:00
5 changed files with 111 additions and 7 deletions

View File

@@ -1,6 +1,6 @@
# TelegramBotAPI
[![Maven Central Version](https://img.shields.io/maven-central/v/dev.inmo/tgbotapi)](https://central.sonatype.com/artifact/dev.inmo/tgbotapi) [![Supported version](https://img.shields.io/badge/Telegram%20Bot%20API-9.0-blue)](https://core.telegram.org/bots/api-changelog#april-11-2025)
[![Maven Central Version](https://img.shields.io/maven-central/v/dev.inmo/tgbotapi)](https://central.sonatype.com/artifact/dev.inmo/tgbotapi) [![Supported version](https://img.shields.io/badge/Telegram%20Bot%20API-9.6-blue)](https://core.telegram.org/bots/api-changelog#april-3-2026)
<!--- [![Telegram Channel](./resources/tg_channel_qr.jpg)](https://t.me/ktgbotapi) --->

View File

@@ -1,6 +1,108 @@
# Types conversations
One of the most important topics in context of tgbotapi is types conversations. This library is very strong-typed and a lot of things are based on types hierarchy. Lets look into the hierarchy of classes for the [Message](https://github.com/InsanusMokrassar/TelegramBotAPI/blob/master/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/message/abstracts/Message.kt#L12) in 0.35.8: [![Message Diagram.png](https://bookstack.inmo.dev/uploads/images/gallery/2021-09/scaled-1680-/message-diagram.png)](https://bookstack.inmo.dev/uploads/images/gallery/2021-09/message-diagram.png)
# Types conversations
One of the most important topics in context of tgbotapi is types conversations. This library is very strong-typed and a lot of things are based on types hierarchy. Lets look into the hierarchy of classes for the [Message](https://github.com/InsanusMokrassar/TelegramBotAPI/blob/master/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/message/abstracts/Message.kt#L12) in 0.35.8:
```mermaid
%%{init: {"flowchart": {"defaultRenderer": "elk"}} }%%
classDiagram
Message <|-- AccessibleMessage
AccessibleMessage <|-- ChatEventMessage
ChatEventMessage <|-- ChannelEventMessage
ChatEventMessage <|-- GroupEventMessage
GroupEventMessage <|-- ChannelDirectMessagesEventMessage
ChannelDirectMessagesEventMessage <|-- CommonChannelDirectMessagesEventMessage
GroupEventMessage <|-- CommonGroupEventMessage
GroupEventMessage <|-- SupergroupEventMessage
SupergroupEventMessage <|-- CommonSupergroupEventMessage
ChatEventMessage <|-- PrivateEventMessage
ChatEventMessage <|-- PrivateForumEventMessage
AccessibleMessage <|-- CommonMessage
CommonMessage <|-- PossiblySentViaBotCommonMessage
PossiblySentViaBotCommonMessage <|-- BusinessContentMessage
BusinessContentMessage <|-- BusinessContentMessageImpl
PossiblySentViaBotCommonMessage <|-- ChannelContentMessage
ChannelContentMessage <|-- ChannelContentMessageImpl
ChannelContentMessage <|-- ChannelPaidPost
ChannelPaidPost <|-- ChannelPaidPostImpl
PossiblySentViaBotCommonMessage <|-- PrivateContentMessage
PrivateContentMessage <|-- PrivateContentMessageImpl
PrivateContentMessage <|-- PrivateForumContentMessage
PrivateForumContentMessage <|-- PrivateForumContentMessageImpl
PossiblySentViaBotCommonMessage <|-- PublicContentMessage
PublicContentMessage <|-- GroupContentMessage
GroupContentMessage <|-- AnonymousGroupContentMessage
AnonymousGroupContentMessage <|-- AnonymousGroupContentMessageImpl
GroupContentMessage <|-- ChannelDirectMessagesContentMessage
ChannelDirectMessagesContentMessage <|-- CommonChannelDirectMessagesContentMessage
CommonChannelDirectMessagesContentMessage <|-- CommonChannelDirectMessagesContentMessageImpl
ChannelDirectMessagesContentMessage <|-- FromChannelChannelDirectMessagesContentMessage
FromChannelChannelDirectMessagesContentMessage <|-- FromChannelChannelDirectMessagesContentMessageImpl
ChannelDirectMessagesContentMessage <|-- SuggestedChannelDirectMessagesContentMessage
SuggestedChannelDirectMessagesContentMessage <|-- CommonSuggestedChannelDirectMessagesContentMessage
CommonSuggestedChannelDirectMessagesContentMessage <|-- CommonSuggestedChannelDirectMessagesContentMessageImpl
SuggestedChannelDirectMessagesContentMessage <|-- FromChannelSuggestedChannelDirectMessagesContentMessage
FromChannelSuggestedChannelDirectMessagesContentMessage <|-- FromChannelSuggestedChannelDirectMessagesContentMessageImpl
GroupContentMessage <|-- CommonGroupContentMessage
CommonGroupContentMessage <|-- CommonGroupContentMessageImpl
GroupContentMessage <|-- ForumContentMessage
ForumContentMessage <|-- AnonymousForumContentMessage
AnonymousForumContentMessage <|-- AnonymousForumContentMessageImpl
ForumContentMessage <|-- CommonForumContentMessage
CommonForumContentMessage <|-- CommonForumContentMessageImpl
ForumContentMessage <|-- FromChannelForumContentMessage
FromChannelForumContentMessage <|-- FromChannelForumContentMessageImpl
GroupContentMessage <|-- FromChannelGroupContentMessage
FromChannelGroupContentMessage <|-- ConnectedFromChannelGroupContentMessage
ConnectedFromChannelGroupContentMessage <|-- ConnectedFromChannelGroupContentMessageImpl
FromChannelGroupContentMessage <|-- FromChannelChannelDirectMessagesContentMessage
FromChannelGroupContentMessage <|-- FromChannelForumContentMessage
FromChannelGroupContentMessage <|-- FromChannelSuggestedChannelDirectMessagesContentMessage
FromChannelGroupContentMessage <|-- UnconnectedFromChannelGroupContentMessage
UnconnectedFromChannelGroupContentMessage <|-- UnconnectedFromChannelGroupContentMessageImpl
GroupContentMessage <|-- PotentiallyFromUserGroupContentMessage
PotentiallyFromUserGroupContentMessage <|-- CommonChannelDirectMessagesContentMessage
PotentiallyFromUserGroupContentMessage <|-- CommonForumContentMessage
PotentiallyFromUserGroupContentMessage <|-- CommonGroupContentMessage
PotentiallyFromUserGroupContentMessage <|-- CommonSuggestedChannelDirectMessagesContentMessage
AccessibleMessage <|-- ContentMessage
ContentMessage <|-- CommonMessage
ContentMessage <|-- PossiblyMediaGroupMessage
PossiblyMediaGroupMessage <|-- CommonMessage
AccessibleMessage <|-- OptionallyFromUserMessage
OptionallyFromUserMessage <|-- ChannelContentMessage
OptionallyFromUserMessage <|-- FromUserMessage
FromUserMessage <|-- BusinessContentMessage
FromUserMessage <|-- CommonChannelDirectMessagesContentMessage
FromUserMessage <|-- CommonForumContentMessage
FromUserMessage <|-- CommonGroupContentMessage
FromUserMessage <|-- CommonSuggestedChannelDirectMessagesContentMessage
FromUserMessage <|-- GroupEventMessage
FromUserMessage <|-- PassportMessage
FromUserMessage <|-- PrivateContentMessage
AccessibleMessage <|-- PassportMessage
AccessibleMessage <|-- PossiblyEditedMessage
PossiblyEditedMessage <|-- CommonMessage
AccessibleMessage <|-- PossiblyForwardedMessage
PossiblyForwardedMessage <|-- CommonMessage
AccessibleMessage <|-- PossiblyPaymentMessage
AccessibleMessage <|-- PossiblyTopicMessage
PossiblyTopicMessage <|-- ForumContentMessage
PossiblyTopicMessage <|-- PrivateForumContentMessage
AccessibleMessage <|-- SignedMessage
SignedMessage <|-- AnonymousForumContentMessage
SignedMessage <|-- AnonymousGroupContentMessage
SignedMessage <|-- ChannelContentMessage
SignedMessage <|-- FromChannelGroupContentMessage
AccessibleMessage <|-- UnknownMessageType
Message <|-- InaccessibleMessage
Message <|-- PossiblyOfflineMessage
PossiblyOfflineMessage <|-- CommonMessage
PossiblyOfflineMessage <|-- PrivateContentMessage
Message <|-- PossiblyPaidMessage
PossiblyPaidMessage <|-- CommonMessage
Message <|-- PossiblyWithEffectMessage
PossiblyWithEffectMessage <|-- PrivateContentMessage
```
As you may see, it is a little bit complex and require several tools for types conversation.

View File

@@ -0,0 +1 @@
This secion contains information about way of getting updates and additional info related to it.

View File

@@ -30,6 +30,7 @@ nav:
- Guides:
- 'tgbotapi/guides/keyboards.md'
- Updates retrieving:
- 'tgbotapi/updates/index.md'
- 'tgbotapi/updates/updates-filters.md'
- 'tgbotapi/updates/long-polling.md'
- 'tgbotapi/updates/webhooks.md'

6
poetry.lock generated
View File

@@ -511,13 +511,13 @@ files = [
[[package]]
name = "mkdocs-mermaid2-plugin"
version = "1.2.1"
version = "1.2.3"
description = "A MkDocs plugin for including mermaid graphs in markdown sources"
optional = false
python-versions = ">=3.8"
files = [
{file = "mkdocs_mermaid2_plugin-1.2.1-py3-none-any.whl", hash = "sha256:22d2cf2c6867d4959a5e0903da2dde78d74581fc0b107b791bc4c7ceb9ce9741"},
{file = "mkdocs_mermaid2_plugin-1.2.1.tar.gz", hash = "sha256:9c7694c73a65905ac1578f966e5c193325c4d5a5bc1836727e74ac9f99d0e921"},
{file = "mkdocs_mermaid2_plugin-1.2.3-py3-none-any.whl", hash = "sha256:33f60c582be623ed53829a96e19284fc7f1b74a1dbae78d4d2e47fe00c3e190d"},
{file = "mkdocs_mermaid2_plugin-1.2.3.tar.gz", hash = "sha256:fb6f901d53e5191e93db78f93f219cad926ccc4d51e176271ca5161b6cc5368c"},
]
[package.dependencies]