Bot API 7.0 and 7.1

CHANGELOG.md

@@ -21,6 +21,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 <!-- markdownlint-configure-file { "MD024": false } -->
 
+## [Unreleased]
+
+> [Bot API 7.0](https://core.telegram.org/bots/api#december-29-2023) (December 29, 2023)
+
+### Added
+
+- The classes `ReactionType`, `ReactionTypeEmoji` and `ReactionTypeCustomEmoji` representing different types of reaction.
+- Updates about a reaction change on a message with non-anonymous reactions, represented by the class `MessageReactionUpdated`
+and the field `MessageReaction` in the class `Update`. The bot must explicitly allow the update to receive it.
+- Updates about reaction changes on a message with anonymous reactions, represented by the class `MessageReactionCountUpdated`
+and the field `MessageReactionCount` in the class `Update`. The bot must explicitly allow the update to receive it.
+- New enum values `MessageReaction`, `MessageReactionCount` for `UpdateType`.
+- Type `ReactionCount`.
+- Request type `SetMessageReactionRequest` that allows bots to react to messages.
+- New method `ITelegramBotClient.SetMessageReactionAsync` that allows bots to react to messages.
+- The field `AvailableReactions` to the class `Chat`.
+
 ## [v20.0.0] - Unreleased
 
 > [Bot API 6.9](https://core.telegram.org/bots/api#september-22-2023) (September 22, 2023)

README.md

@@ -1,7 +1,7 @@
 # .NET Client for Telegram Bot API
 
 [![package](https://img.shields.io/nuget/vpre/Telegram.Bot.svg?label=Telegram.Bot&style=flat-square)](https://www.nuget.org/packages/Telegram.Bot)
-[![Bot API Version](https://img.shields.io/badge/Bot%20API-6.9%20(September%2022,%202023)-f36caf.svg?style=flat-square)](https://core.telegram.org/bots/api#september-22-2023)
+[![Bot API Version](https://img.shields.io/badge/Bot%20API-7.0%20(December%2029,%202023)-f36caf.svg?style=flat-square)](https://core.telegram.org/bots/api#december-29-2023)
 [![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)
 

src/EnumSerializer.Generator/EnumSerializer.Generator.csproj

@@ -14,9 +14,9 @@
 
   <!-- The following libraries include the source generator interfaces and types we need -->
   <ItemGroup>
-    <PackageReference Include="Meziantou.Analyzer" Version="2.0.85" PrivateAssets="all" />
+    <PackageReference Include="Meziantou.Analyzer" Version="2.0.133" PrivateAssets="all" />
     <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
-    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.7.0" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" PrivateAssets="all" />
     <PackageReference Include="Scriban" Version="5.9.0" GeneratePathProperty="true" PrivateAssets="all" />
 
     <!-- This ensures the library will be packaged as a source generator when we use `dotnet pack` -->

src/Telegram.Bot/Converters/ReactionTypeConverter.cs

@@ -0,0 +1,56 @@
+using System.Reflection;
+using Newtonsoft.Json.Linq;
+
+namespace Telegram.Bot.Converters;
+
+internal class ReactionTypeConverter : JsonConverter
+{
+    static readonly TypeInfo BaseType = typeof(ReactionType).GetTypeInfo();
+
+    public override bool CanWrite => false;
+    public override bool CanRead => true;
+    public override bool CanConvert(Type objectType) =>
+        BaseType.IsAssignableFrom(objectType.GetTypeInfo());
+
+    public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer)
+    {
+        if (value is null)
+        {
+            writer.WriteNull();
+        }
+        else
+        {
+            var jo = JObject.FromObject(value);
+            jo.WriteTo(writer);
+        }
+    }
+
+    public override object? ReadJson(
+        JsonReader reader,
+        Type objectType,
+        object? existingValue,
+        JsonSerializer serializer)
+    {
+        var jo = JObject.Load(reader);
+        var type = jo["type"]?.Value<string>();
+
+        if (type is null)
+        {
+            return null;
+        }
+
+        var actualType = type switch
+        {
+            "emoji"        => typeof(ReactionTypeEmoji),
+            "custom_emoji" => typeof(ReactionTypeCustomEmoji),
+            _              => throw new JsonSerializationException($"Unknown reaction type value of '{jo["type"]}'")
+        };
+
+        // Remove status because status property only has getter
+        jo.Remove("type");
+        var value = Activator.CreateInstance(actualType)!;
+        serializer.Populate(jo.CreateReader(), value);
+
+        return value;
+    }
+}

src/Telegram.Bot/Requests/Available methods/Messages/SetMessageReactionRequest.cs

@@ -0,0 +1,57 @@
+// ReSharper disable once CheckNamespace
+using Telegram.Bot.Requests.Abstractions;
+
+namespace Telegram.Bot.Requests;
+
+/// <summary>
+/// Use this method to change the chosen reactions on a message. Service messages can't be reacted to.
+/// Automatically forwarded messages from a channel to its discussion group have the same
+/// available reactions as messages in the channel.
+/// Returns <see langword="true"/> on success.
+/// </summary>
+[JsonObject(MemberSerialization.OptIn, NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
+public class SetMessageReactionRequest : RequestBase<bool>,
+    IChatTargetable
+{
+    /// <inheritdoc />
+    [JsonProperty(Required = Required.Always)]
+    public ChatId ChatId { get; }
+
+    /// <summary>
+    /// Identifier of the target message. If the message belongs to a media group, the reaction
+    /// is set to the first non-deleted message in the group instead.
+    /// </summary>
+    [JsonProperty(Required = Required.Always)]
+    public int MessageId { get; }
+
+    /// <summary>
+    /// New list of reaction types to set on the message. Currently, as non-premium users, bots can
+    /// set up to one reaction per message. A custom emoji reaction can be used if it is either
+    /// already present on the message or explicitly allowed by chat administrators.
+    /// </summary>
+    [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+    public ReactionType[]? Reaction { get; set; }
+
+    /// <summary>
+    /// Pass <see langword="true"/> to set the reaction with a big animation
+    /// </summary>
+    [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+    public bool? IsBig { get; set; }
+
+    /// <summary>
+    /// Initializes a new request with chatId and messageId
+    /// </summary>
+    /// <param name="chatId">Unique identifier for the target chat or username of the target channel
+    /// (in the format <c>@channelusername</c>)
+    /// </param>
+    /// <param name="messageId">
+    /// Identifier of the target message. If the message belongs to a media group, the reaction
+    /// is set to the first non-deleted message in the group instead.
+    /// </param>
+    public SetMessageReactionRequest(ChatId chatId, int messageId)
+    : base("setMessageReaction")
+    {
+        ChatId = chatId;
+        MessageId = messageId;
+    }
+}

src/Telegram.Bot/Telegram.Bot.csproj

@@ -4,7 +4,6 @@
     <TargetFrameworks>netstandard2.0;net6.0</TargetFrameworks>
     <LangVersion>11</LangVersion>
     <Nullable>enable</Nullable>
-    <WarningLevel>7</WarningLevel>
     <EnableNETAnalyzers>True</EnableNETAnalyzers>
     <AnalysisMode>AllEnabledByDefault</AnalysisMode>
     <AnalysisLevel>latest-recommended</AnalysisLevel>
@@ -52,7 +51,7 @@
                                            'HttpClient.GetAsync(Uri, HttpCompletionOption, CancellationToken)' instead
                                            of 'HttpClient.GetAsync(string, HttpCompletionOption, CancellationToken)' -->
     <NoWarn>$(NoWarn);CA1031</NoWarn> <!-- Catch a more specific allowed exception type, or rethrow the exception -->
-    <NoWarn>$(NoWarn);MA0046;MA0048;MA0051</NoWarn>
+    <NoWarn>$(NoWarn);MA0048;MA0051</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
@@ -70,7 +69,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)'=='netstandard2.0'">
@@ -79,9 +78,9 @@
   </ItemGroup>
 
   <ItemGroup Label="Dev">
-    <PackageReference Include="Meziantou.Analyzer" Version="2.0.85" PrivateAssets="all" />
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
-    <PackageReference Include="JetBrains.Annotations" Version="2023.2.0" PrivateAssets="All" />
+    <PackageReference Include="Meziantou.Analyzer" Version="2.0.133" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
+    <PackageReference Include="JetBrains.Annotations" Version="2023.3.0" PrivateAssets="All" />
     <PackageReference Include="Nullable" Version="1.3.1" PrivateAssets="all" />
     <ProjectReference Include="..\EnumSerializer.Generator\EnumSerializer.Generator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
   </ItemGroup>

src/Telegram.Bot/TelegramBotClientExtensions.ApiMethods.cs

@@ -1804,6 +1804,49 @@ await botClient.ThrowIfNull()
                 cancellationToken)
             .ConfigureAwait(false);
 
+    /// <summary>
+    /// Use this method to change the chosen reactions on a message. Service messages can't be reacted to.
+    /// Automatically forwarded messages from a channel to its discussion group have the same
+    /// available reactions as messages in the channel.
+    /// </summary>
+    /// <param name="botClient">An instance of <see cref="ITelegramBotClient"/></param>
+    /// <param name="chatId">
+    /// Unique identifier for the target chat or username of the target channel
+    /// (in the format <c>@channelusername</c>)
+    /// </param>
+    /// <param name="messageId">
+    /// Identifier of the target message. If the message belongs to a media group, the reaction
+    /// is set to the first non-deleted message in the group instead.
+    /// </param>
+    /// <param name="reaction">
+    /// New list of reaction types to set on the message. Currently, as non-premium users, bots can
+    /// set up to one reaction per message. A custom emoji reaction can be used if it is either
+    /// already present on the message or explicitly allowed by chat administrators.
+    /// </param>
+    /// <param name="isBig">
+    /// Pass <see langword="true"/> to set the reaction with a big animation
+    /// </param>
+    /// <param name="cancellationToken">
+    /// A cancellation token that can be used by other objects or threads to receive notice of cancellation
+    /// </param>
+    public static async Task SetMessageReactionAsync(
+        this ITelegramBotClient botClient,
+        ChatId chatId,
+        int messageId,
+        ReactionType[]? reaction,
+        bool? isBig,
+        CancellationToken cancellationToken = default
+    ) =>
+        await botClient.ThrowIfNull()
+            .MakeRequestAsync(
+                new SetMessageReactionRequest(chatId, messageId)
+                {
+                    Reaction = reaction,
+                    IsBig = isBig,
+                },
+                cancellationToken)
+            .ConfigureAwait(false);
+
     /// <summary>
     /// Use this method to get a list of profile pictures for a user.
     /// </summary>

src/Telegram.Bot/Types/Chat.cs

@@ -68,6 +68,13 @@ public class Chat
     [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
     public string[]? ActiveUsernames { get; set; }
 
+    /// <summary>
+    /// Optional. List of available reactions allowed in the chat. If omitted, then all <see cref="ReactionTypeEmoji.Emoji">emoji reactions</see> are allowed.
+    /// Returned only in <see cref="Requests.GetChatRequest"/>.
+    /// </summary>
+    [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+    public ReactionType[]? AvailableReactions { get; set; }
+
     /// <summary>
     /// Optional. Custom emoji identifier of emoji status of the other party in a private chat.
     /// Returned only in <see cref="Requests.GetChatRequest"/>.

src/Telegram.Bot/Types/Enums/UpdateType.cs

@@ -1,4 +1,4 @@
-namespace Telegram.Bot.Types.Enums;
+namespace Telegram.Bot.Types.Enums;
 
 /// <summary>
 /// The type of an <see cref="Update"/>
@@ -47,37 +47,47 @@ public enum UpdateType
     EditedChannelPost,
 
     /// <summary>
-    /// The <see cref="Update"/> contains an <see cref="ShippingQuery"/>
+    /// The <see cref="Update"/> contains an <see cref="Payments.ShippingQuery"/>
     /// </summary>
     ShippingQuery,
 
     /// <summary>
-    /// The <see cref="Update"/> contains an <see cref="PreCheckoutQuery"/>
+    /// The <see cref="Update"/> contains an <see cref="Payments.PreCheckoutQuery"/>
     /// </summary>
     PreCheckoutQuery,
 
     /// <summary>
-    /// The <see cref="Update"/> contains an <see cref="Poll"/>
+    /// The <see cref="Update"/> contains an <see cref="Types.Poll"/>
     /// </summary>
     Poll,
 
     /// <summary>
-    /// The <see cref="Update"/> contains an <see cref="PollAnswer"/>
+    /// The <see cref="Update"/> contains an <see cref="Types.PollAnswer"/>
     /// </summary>
     PollAnswer,
 
     /// <summary>
-    /// The <see cref="Update"/> contains an <see cref="MyChatMember"/>
+    /// The <see cref="Update"/> contains an <see cref="Types.ChatMember"/>
     /// </summary>
     MyChatMember,
 
     /// <summary>
-    /// The <see cref="Update"/> contains an <see cref="ChatMember"/>
+    /// The <see cref="Update"/> contains an <see cref="Types.ChatMember"/>
     /// </summary>
     ChatMember,
 
     /// <summary>
-    /// The <see cref="Update"/> contains an <see cref="ChatJoinRequest"/>
+    /// The <see cref="Update"/> contains an <see cref="Types.ChatJoinRequest"/>
     /// </summary>
     ChatJoinRequest,
+
+    /// <summary>
+    /// The <see cref="Update"/> contains an <see cref="Types.MessageReactionUpdated"/>
+    /// </summary>
+    MessageReaction,
+
+    /// <summary>
+    /// The <see cref="Update"/> contains an <see cref="Types.MessageReactionCountUpdated"/>
+    /// </summary>
+    MessageReactionCount,
 }

src/Telegram.Bot/Types/MessageReactionCountUpdated.cs

@@ -0,0 +1,35 @@
+using Newtonsoft.Json.Converters;
+
+namespace Telegram.Bot.Types;
+
+/// <summary>
+/// This object represents reaction changes on a message with anonymous reactions.
+/// </summary>
+[JsonObject(MemberSerialization.OptIn, NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
+public class MessageReactionCountUpdated
+{
+    /// <summary>
+    /// The chat containing the message
+    /// </summary>
+    [JsonProperty(Required = Required.Always)]
+    public Chat Chat { get; } = default!;
+
+    /// <summary>
+    /// Unique message identifier inside the chat
+    /// </summary>
+    [JsonProperty(Required = Required.Always)]
+    public int MessageId { get; } = default!;
+
+    /// <summary>
+    /// Date of the change
+    /// </summary>
+    [JsonProperty(Required = Required.Always)]
+    [JsonConverter(typeof(UnixDateTimeConverter))]
+    public DateTime Date { get; } = default!;
+
+    /// <summary>
+    /// List of reactions that are present on the message
+    /// </summary>
+    [JsonProperty(Required = Required.Always)]
+    public ReactionCount[] Reactions { get; } = default!;
+}