Here is Updater
!! Preview !!
This is your telegram updater package written in C# and .NET 6. The updater is supposed to fetch and handle new updates coming from bot api server. It's written on top of TelegramBots/Telegram.Bot: .NET Client for Telegram Bot API package
More support
We can talk through @TUTalkings if you want to.
Why use this?
- Updater uses update handlers which are a great help to write clean, simple to write and read and more powerful code base.
- Updater provides
Filter<T>class that helps you to easily choose the right handler for incoming updates. Take a look at code below describing a handler:
using Telegram.Bot.Types;
using TelegramUpdater.FilterAttributes.Attributes;
using TelegramUpdater.Filters;
using TelegramUpdater.UpdateContainer;
using TelegramUpdater.UpdateHandlers.Scoped.ReadyToUse;
namespace ConsoleApp;
[Command("test"), Private]
internal class MyScopedMessageHandler : MessageHandler
{
protected override async Task HandleAsync(IContainer<Message> _)
{
await ResponseAsync("Tested!");
}
}
- Simple setup
- Useful options
updater = new Updater("BotToken",
new UpdaterOptions(
maxDegreeOfParallelism: 10, // maximum update process tasks count at the same time
// Eg: first 10 updates are answers quickly, but others should wait
// for any of that 10 to be done.
.AddScopedUpdateHandler<MyScopedMessageHandler, Message>(); // Scoped handler;
await updater.StartAsync(); // 🔥 Fire up and block!
OpenChannelMethod! You can use this to wait for a user response.- Batch of extension methods to increase speed and make cleaner code.
As instance ChannelUserClick is an helper method for OpenChannel that waits for a user click.
[Command("start"), Private]
internal sealed class MyMessageHandler : MessageHandler
{
protected override async Task HandleAsync(IContainer<Message> _)
{
await AwaitButtonClickAsync(
TimeSpan.FromSeconds(10), new CallbackQueryRegex("^hello"))
.IfNotNull(async answer =>
{
await answer.EditAsync(text: "Well ...");
})
.Else(async _ =>
{
await ResponseAsync("Slow");
});
}
}
ExceptionHandlers, handle exceptions like a pro with highly customizable exceptions handlers. you specify exception type, message match, handler type and ...
.StepTwo(CommonExceptions.ParsingException(
(updater, ex) =>
{
updater.Logger.LogWarning(exception: ex, "Handler has entity parsing error!");
return Task.CompletedTask;
},
allowedHandlers: new[]
{
typeof(AboutMessageHandler),
typeof(MyScopedMessageHandler)
}))
- Supports DI and batch of extension methods for hosted or webhook apps ( thanks to Telegram.Bot webhook example )
- Updater has a lot of base classes, interfaces and generic types to make everything highly customizable.
- More ...
Getting Started
Here are starting pack for common SDKs in .NET
TelegramUpdater in available in nuget, Install it first.
Basic
If you're using a console app with no Hosting and IServiceCollection then it's your choice
And even if you don't, you're suggested to!
Base class of this package is Updater, but there's a helper class in case of basic apps called UpdaterBuilder which helps you
get familiar with the package.
UpdaterBuilder helps you build Updater in steps with fully documented methods.
See UpdaterProduction and
ConsoleApp for instance.
If you're looking for a quick basic example:
// See https://aka.ms/new-console-template for more information
using TelegramUpdater;
var updater = new UpdaterBuilder("BOT_TOKEN")
.StepOne()
.StepTwo(inherit: false) // Add default exception handler
.StepThree( // Quick handler
async container => await container.Response("Started!"),
FilterCutify.OnCommand("start"));
// ---------- Start! ----------
await updater.StartAsync(); // 🔥 Fire up and block!
Of course this can be even less, but these're required for production! For instance StepTwo adds a default exception handler ( Take a look at methods docs! )
IHost apps
It maybe better if you use Updater in a app where IServiceCollection and IServiceProvider are available. Like WorkerService!
Use this package for a set of useful extensions for IHosting apps.
Take a look at two examples of worker services
- WorkerService, A worker service with default updater service.
- ManualWriterWorkerService, A worker service that gets updates for a custom external service. In this example i used PollingExtension as an external updater writer.
A quick worker service
using WorkerService;
IHost host = Host.CreateDefaultBuilder(args)
.ConfigureServices(services =>
{
services.AddTelegramUpdater(
"BOT_TOKEN",
default,
(builder) => builder
.AddMessageHandler<SimpleMessageHandler>()
);
})
.Build();
await host.RunAsync();
Road Map
- [ ] Add ready to use handlers for all updates
- [ ] Tests
- [ ] Add more filters
Next?
Find documents under https://telegramupdater.github.io/Docs/ ( Yet Working on it ... )