Telegram.Bot.InteractivityHelper 1.4.1.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package Telegram.Bot.InteractivityHelper --version 1.4.1.2
NuGet\Install-Package Telegram.Bot.InteractivityHelper -Version 1.4.1.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Telegram.Bot.InteractivityHelper" Version="1.4.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Telegram.Bot.InteractivityHelper --version 1.4.1.2
#r "nuget: Telegram.Bot.InteractivityHelper, 1.4.1.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Telegram.Bot.InteractivityHelper as a Cake Addin
#addin nuget:?package=Telegram.Bot.InteractivityHelper&version=1.4.1.2

// Install Telegram.Bot.InteractivityHelper as a Cake Tool
#tool nuget:?package=Telegram.Bot.InteractivityHelper&version=1.4.1.2

Telegram Interactivity Tools

Requirements

Setup

// Create a bot client.
var botClient = new TelegramBotClient("YOURKEY");
botClient.UseInteractivity(new Interactivity.Types.InteractivityConfiguration()
{
    //Timeout time for an interactivity process.
    DefaultTimeOutTime = TimeSpan.FromMinutes(10)
});
//MANDATORY
botClient.StartReceiving();

Usage

private static async void OnMessageSent(object sender, MessageEventArgs e)
{
    if (e.Message.Text == "/hello")
    {
        //Ask the user for his name
        await botClient.SendTextMessageAsync(e.Message.Chat.Id, "Hello! What's your name?");
        // Get the client's interactivity object
        var interactivity = botClient.GetInteractivity();
        //Wait for a message.
        var result = await interactivity.WaitForMessageAsync(e.Message.Chat, e.Message.From);
        if (result.Value != null)
        {
            // The user responded in time.
            await botClient.SendTextMessageAsync(e.Message.Chat.Id, $"Hello, {result.Value}!");
        }
        else if (result.TimedOut)
        {
            // The user didn't respond within the set DefaultTimeOutTime, which is 2 minutes by default unless changed in the Configuration.
            await botClient.SendTextMessageAsync(e.Message.Chat.Id, $"The process timed out.");
        }
        else
        {
            // An error has occured.
            await botClient.SendTextMessageAsync(e.Message.Chat.Id, $"An unknown error has occured.");
        }
    }
}
TL;DR

To wait for a message, await the WaitForMessageAsync() function.

Extras

Conditions

You can set a condition for a message to be considered a valid response only if it is validated by passing it the Predicate<Message> parameter. Like so:

// Get the client's interactivity.
var interactivity = botClient.GetInteractivity();
// Ask the user for their age.
await botClient.SendMessageAsync(chatId, 
    $"Hello! Please enter your age.");
// Wait for a message that can be parsed as an integer.
int age = 0;
await botClient
    .WaitForMessageAsync(
        e.Message.Chat,
        e.Message.From,
        sentMessage => int.TryParse(sentMessage.Text, out age));
Console.WriteLine($"The user is {age} years old!");
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.2 is compatible.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.5.0 1,425 3/6/2021
1.4.1.2 839 3/31/2020