Merge pull request #1457 from TelegramBots/develop

Bot API 8.3 + helpers

Author: wiz0u

.azure-pipelines/variables.yml

@@ -1,7 +1,7 @@
 variables:
   - group: Integration Tests Variables
   - name: versionPrefix
-    value: 22.3.0
+    value: 22.4.0
   - name: versionSuffix
     value: ''
   - name: ciVersionSuffix

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Robin Müller, Telegram Bots
+Copyright (c) 2016-2025 Telegram Bots
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,7 @@
 # .NET Client for Telegram Bot API
 
 [![Nuget](https://img.shields.io/nuget/vpre/Telegram.Bot.svg?label=Telegram.Bot&style=flat-square&color=d8b541)](https://www.nuget.org/packages/Telegram.Bot)
-[![Bot API 8.2](https://img.shields.io/badge/Bot_API-8.2-f36caf.svg?style=flat-square)](https://core.telegram.org/bots/api)
+[![Bot API 8.3](https://img.shields.io/badge/Bot_API-8.3-f36caf.svg?style=flat-square)](https://core.telegram.org/bots/api)
 [![Documentations](https://img.shields.io/badge/Documentations-Book-orange.svg?style=flat-square)](https://telegrambots.github.io/book/)
 [![Telegram Chat](https://img.shields.io/badge/Support_Chat-Telegram-blue.svg?style=flat-square)](https://t.me/joinchat/B35YY0QbLfd034CFnvCtCA)  
 [![Master build](https://img.shields.io/azure-devops/build/tgbots/14f9ab3f-313a-4339-8534-e8b96c7763cc/6?style=flat-square&label=master)](https://dev.azure.com/tgbots/Telegram.Bot/_build/latest?definitionId=6&branchName=master)

src/Telegram.Bot/Extend.Types.cs

@@ -65,6 +65,35 @@ public partial class User
         public override string ToString() => Username != null ? $"@{Username} ({Id})" : $"{FirstName}{LastName?.Insert(0, " ")} ({Id})";
     }
 
+    public partial class ChatMember
+    {
+        /// <summary>Check if the user is chat admin or owner</summary>
+        [JsonIgnore]
+        public bool IsAdmin => Status is ChatMemberStatus.Administrator or ChatMemberStatus.Creator;
+        /// <summary>Check if the user is in the chat</summary>
+        [JsonIgnore]
+        public bool IsInChat => Status switch
+        {
+            ChatMemberStatus.Left or ChatMemberStatus.Kicked => false,
+            ChatMemberStatus.Restricted => ((ChatMemberRestricted)this).IsMember,
+            _ => true
+        };
+    }
+
+    public partial class ChatPermissions
+    {
+        /// <summary>Initializes a new <see cref="ChatPermissions"/> instance with all fields set to <see langword="false"/>.</summary>
+        public ChatPermissions() { }
+        /// <summary>Initializes a new <see cref="ChatPermissions"/> instance with all fields set to the specified value.</summary>
+        /// <param name="defaultValue"><see langword="true"/> to allow all permissions by default</param>
+        public ChatPermissions(bool defaultValue)
+        {
+            CanSendMessages = CanSendAudios = CanSendDocuments = CanSendPhotos = defaultValue;
+            CanSendVideos = CanSendVideoNotes = CanSendVoiceNotes = CanSendPolls = CanSendOtherMessages = defaultValue;
+            CanAddWebPagePreviews = CanChangeInfo = CanInviteUsers = CanPinMessages = CanManageTopics = defaultValue;
+        }
+    }
+
     public partial class ReplyParameters
     {
         /// <summary>Implicit operator when you just want to reply to a message in same chat</summary>
@@ -162,16 +191,34 @@ public ReplyKeyboardMarkup(params KeyboardButton[] keyboardRow) : this(new List<
 
             /// <summary>Generates a reply keyboard markup with one button</summary>
             /// <param name="text">Button's text</param>
+            [return: NotNullIfNotNull(nameof(text))]
             public static implicit operator ReplyKeyboardMarkup?(string? text) => text is null ? default : new(text);
 
             /// <summary>Generates a reply keyboard markup with multiple buttons on one row</summary>
             /// <param name="texts">Texts of buttons</param>
+            [return: NotNullIfNotNull(nameof(texts))]
             public static implicit operator ReplyKeyboardMarkup?(string[]? texts) => texts is null ? default : new[] { texts };
 
             /// <summary>Generates a reply keyboard markup with multiple buttons</summary>
-            /// <param name="textsItems">Texts of buttons</param>
-            public static implicit operator ReplyKeyboardMarkup?(string[][]? textsItems) => textsItems is null ? default
-                : new ReplyKeyboardMarkup(textsItems.Select(texts => texts.Select(t => new KeyboardButton(t)).ToList()).ToList());
+            /// <param name="texts">Texts of buttons</param>
+            [return: NotNullIfNotNull(nameof(texts))]
+            public static implicit operator ReplyKeyboardMarkup?(string[][]? texts) => texts is null ? default
+                : new ReplyKeyboardMarkup(texts.Select(texts => texts.Select(t => new KeyboardButton(t)).ToList()).ToList());
+
+            /// <summary>Generates a reply keyboard markup with one button</summary>
+            /// <param name="button">Keyboard button</param>
+            [return: NotNullIfNotNull(nameof(button))]
+            public static implicit operator ReplyKeyboardMarkup?(KeyboardButton? button) => button is null ? default : new(button);
+
+            /// <summary>Generates a reply keyboard markup with multiple buttons on one row</summary>
+            /// <param name="buttons">Keyboard buttons</param>
+            [return: NotNullIfNotNull(nameof(buttons))]
+            public static implicit operator ReplyKeyboardMarkup?(KeyboardButton[]? buttons) => buttons is null ? default : new([buttons]);
+
+            /// <summary>Generates a reply keyboard markup with multiple buttons</summary>
+            /// <param name="buttons">Keyboard buttons</param>
+            [return: NotNullIfNotNull(nameof(buttons))]
+            public static implicit operator ReplyKeyboardMarkup?(IEnumerable<KeyboardButton>[]? buttons) => buttons is null ? default : new(buttons);
 
             /// <summary>Add a button to the last row</summary>
             /// <param name="button">The button or text to add</param>
@@ -242,19 +289,17 @@ public InlineKeyboardMarkup(params InlineKeyboardButton[] inlineKeyboardRow) : t
             /// <summary>Generate an inline keyboard markup with one button</summary>
             /// <param name="buttonText">Text of the button</param>
             [return: NotNullIfNotNull(nameof(buttonText))]
-            public static implicit operator InlineKeyboardMarkup?(string? buttonText) => buttonText is null ? default : new(buttonText!);
-
-            /// <summary>Generate an inline keyboard markup from multiple buttons</summary>
-            /// <param name="inlineKeyboard">Keyboard buttons</param>
-            [return: NotNullIfNotNull(nameof(inlineKeyboard))]
-            public static implicit operator InlineKeyboardMarkup?(IEnumerable<InlineKeyboardButton>[]? inlineKeyboard)
-                => inlineKeyboard is null ? default : new(inlineKeyboard);
+            public static implicit operator InlineKeyboardMarkup?(string? buttonText) => buttonText is null ? default : new(buttonText);
 
             /// <summary>Generate an inline keyboard markup from multiple buttons on 1 row</summary>
-            /// <param name="inlineKeyboard">Keyboard buttons</param>
-            [return: NotNullIfNotNull(nameof(inlineKeyboard))]
-            public static implicit operator InlineKeyboardMarkup?(InlineKeyboardButton[]? inlineKeyboard)
-                => inlineKeyboard is null ? default : new(inlineKeyboard);
+            /// <param name="buttons">Keyboard buttons</param>
+            [return: NotNullIfNotNull(nameof(buttons))]
+            public static implicit operator InlineKeyboardMarkup?(InlineKeyboardButton[]? buttons) => buttons is null ? default : new(buttons);
+
+            /// <summary>Generate an inline keyboard markup from multiple buttons</summary>
+            /// <param name="buttons">Keyboard buttons</param>
+            [return: NotNullIfNotNull(nameof(buttons))]
+            public static implicit operator InlineKeyboardMarkup?(IEnumerable<InlineKeyboardButton>[]? buttons) => buttons is null ? default : new(buttons);
 
             /// <summary>Add a button to the last row</summary>
             /// <param name="button">The button to add</param>
@@ -297,6 +342,19 @@ public InlineKeyboardMarkup AddNewRow(params InlineKeyboardButton[] buttons)
 
         public partial class InlineKeyboardButton
         {
+            /// <summary>Creates an inline keyboard button for external URL or for data to be sent in a <see cref="CallbackQuery">callback query</see> to the bot when the button is pressed, 1-64 bytes</summary>
+            /// <param name="text">Label text on the button</param>
+            /// <param name="callbackDataOrUrl">URL (starting with http:// or https://) to be opened, or data (1-64 characters) to be sent in a <see cref="CallbackQuery">callback query</see> to the bot, when the button is pressed</param>
+            [SetsRequiredMembers]
+            public InlineKeyboardButton(string text, string callbackDataOrUrl)
+            {
+                Text = text;
+                if (callbackDataOrUrl.StartsWith("http://", StringComparison.OrdinalIgnoreCase) || callbackDataOrUrl.StartsWith("https://", StringComparison.OrdinalIgnoreCase))
+                    Url = callbackDataOrUrl;
+                else
+                    CallbackData = callbackDataOrUrl;
+            }
+
             /// <summary>Performs an implicit conversion from <see cref="string"/> to <see cref="InlineKeyboardButton"/> with callback data</summary>
             /// <param name="textAndCallbackData">Label text and callback data of the button</param>
             /// <returns>The result of the conversion.</returns>

src/Telegram.Bot/Extensions/FormatExtensions.cs

@@ -158,7 +158,7 @@ public static string ToHtml(string message, MessageEntity[]? entities)
                     if (tag[0] == 'a')
                     {
                         if (nextEntity.Type is MessageEntityType.TextLink)
-                            tag = $"<a href=\"{nextEntity.Url}\">";
+                            tag = $"<a href=\"{Escape(nextEntity.Url)}\">";
                         else if (nextEntity.Type is MessageEntityType.TextMention)
                             tag = $"<a href=\"tg://user?id={nextEntity.User?.Id}\">";
                     }

src/Telegram.Bot/Requests/Available methods/AnswerCallbackQueryRequest.cs

@@ -1,3 +1,4 @@
+// GENERATED FILE - DO NOT MODIFY MANUALLY
 namespace Telegram.Bot.Requests;
 
 /// <summary>Use this method to send answers to callback queries sent from <a href="https://core.telegram.org/bots/features#inline-keyboards">inline keyboards</a>. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert<para>Returns: </para></summary>

src/Telegram.Bot/Requests/Available methods/Commands/DeleteMyCommandsRequest.cs

@@ -1,3 +1,4 @@
+// GENERATED FILE - DO NOT MODIFY MANUALLY
 namespace Telegram.Bot.Requests;
 
 /// <summary>Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, <a href="https://core.telegram.org/bots/api#determining-list-of-commands">higher level commands</a> will be shown to affected users.<para>Returns: </para></summary>

src/Telegram.Bot/Requests/Available methods/Commands/GetMyCommandsRequest.cs

@@ -1,3 +1,4 @@
+// GENERATED FILE - DO NOT MODIFY MANUALLY
 namespace Telegram.Bot.Requests;
 
 /// <summary>Use this method to get the current list of the bot's commands for the given scope and user language.<para>Returns: An Array of <see cref="BotCommand"/> objects. If commands aren't set, an empty list is returned.</para></summary>

src/Telegram.Bot/Requests/Available methods/Commands/SetMyCommandsRequest.cs

@@ -1,3 +1,4 @@
+// GENERATED FILE - DO NOT MODIFY MANUALLY
 namespace Telegram.Bot.Requests;
 
 /// <summary>Use this method to change the list of the bot's commands. See <a href="https://core.telegram.org/bots/features#commands">this manual</a> for more details about bot commands.<para>Returns: </para></summary>

src/Telegram.Bot/Requests/Available methods/CreateChatSubscriptionInviteLinkRequest.cs

@@ -1,3 +1,4 @@
+// GENERATED FILE - DO NOT MODIFY MANUALLY
 namespace Telegram.Bot.Requests;
 
 /// <summary>Use this method to create a <a href="https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions">subscription invite link</a> for a channel chat. The bot must have the <em>CanInviteUsers</em> administrator rights. The link can be edited using the method <see cref="TelegramBotClientExtensions.EditChatSubscriptionInviteLink">EditChatSubscriptionInviteLink</see> or revoked using the method <see cref="TelegramBotClientExtensions.RevokeChatInviteLink">RevokeChatInviteLink</see>.<para>Returns: The new invite link as a <see cref="ChatInviteLink"/> object.</para></summary>