SkyNeg.Telegram.BotCore 0.40.0

Telegram Bot Service Core library

Framework to build Telegram Bots using Request-Controller pattern with dialogs support

Configuration

Use one of available AddBot extension Dependency Injection methods

AddBot(this IServiceCollection collection, BotOptions botOptions)

or

AddBot(this IServiceCollection collection, IConfiguration botOptionsConfiguration)

Bot Info

To configure response version for /botinfo command implement IBotInfoService interface and inject implementation using dependency injection.

services.AddSingleton<IBotInfoService, BotInfoService>();

Usage

1. Add Bot Service

   services.AddBot(hostContext.Configuration.GetSection("TelegramBot"));
   

2. Add Request that defines data model accepted by bot
   1. Request model should implement IRequest interface
   2. Request model should be decorated with RequestAttribute attribute. Attribute defines command for your request and additional behaviour of your request (for example suppressing dialog flag)
   3. Define public properties for your Request model decorated with RequestPropertyAttribute attribute. These properties can be used to enrich your request with additional data
   4. Below is example request. It can be executed from the Telegram using commands: /myrequest_1, /myrequest, /myrequest_42, etc

   [Request("myrequest")]
   public class MyRequest : IRequest
   {
       [RequestProperty(0)]
       public int MyProperty { get; set; }
   }
   

3. Add Request Controller with logic for new command. Each Request Controller class:
   1. Must implement IRequestController interface
   2. It's constructor may contain dependencies that will be injected with DI (Each Request Controller behaves like a singleton)
   3. Example:

   public class MyRequestController : IRequestController<MyRequest>
   {
       private readonly ILogger _logger;
       private readonly ITelegramBotClient _client;
       private readonly ISampleDependencyService _sampleDependencyService;
       public MyRequestController(ILoggerFactory loggerFactory, ITelegramBotClient client, ISampleDependencyService sampleDependencyService)
       {
           _sampleDependencyService = sampleDependencyService;
           _client = client;
           _logger = loggerFactory?.CreateLogger(GetType()) ?? throw new ArgumentNullException(nameof(loggerFactory));
       }
   
       public async Task<RequestResult> ExecuteAsync(MyRequest request, RequestContext context, CancellationToken cancellationToken)
       {
           await _sampleDependencyService.DoWork(requestContext.Request.Text, requestContext.RequestAborted);
           return RequestResult.Completed;
       }
   }
   

Dialogs

1. To request additional information from the user and handle next message from the user by the same controller, return RequestStatus.InProgress status in RequestResult from ExecuteAsync method of your controller
   1. Next message text can be retrieved within the controller request.Text parameter
   2. Additional data (media, etc) can be retrieved from the context.Update parameter
2. When Dialog is finished, return RequestStatus.Finished status with RequestResult
3. When some request has a priority over an active dialog, add SuppressDialog RequestFlags to RequestAttribute over the request. Example: CancelRequest

Links to other Request

1. To create a link to another request call Request.ToLink() extension method
2. To create a callback data for button call Request.ToCallbackData() extension method