TgCore 1.0.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package TgCore --version 1.0.0
NuGet\Install-Package TgCore -Version 1.0.0
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="TgCore" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="TgCore" Version="1.0.0" />
<PackageReference Include="TgCore" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add TgCore --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: TgCore, 1.0.0"
#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.
#:package TgCore@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=TgCore&version=1.0.0
#tool nuget:?package=TgCore&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
TgCore
A flexible .NET engine for creating Telegram bots
The library helps quickly and structuredly build bots in C#, abstracting the routine work with the Telegram API and providing basic infrastructure.
Minimum working bot
using TgCore;
// 1. Create a bot instance
var bot = new TelegramBot(new BotOptions("YOUR_BOT_TOKEN"));
// 2. Create handlers
async Task UpdateHandler(Update update)
{
if (update.Type == UpdateType.Message && update.Text != null)
{
await bot.Message.SendText(update.GetFrom!.Id, $"You said: {update.Text}");
}
}
async Task ErrorHandler(Exception exception, Update? update)
{
Console.WriteLine($"Error: {exception.Message}");
}
// 3. Register handlers
bot.AddUpdateHandler(UpdateHandler);
bot.AddErrorHandler(ErrorHandler);
// 4. Start the bot
await bot.Run();
// 5. Stop (if needed)
await bot.Stop();
Basic concepts
UpdateHandler Handles all user actions:
async Task UpdateHandler(Update update)
{
// Determine the event type
switch (update.Type)
{
case UpdateType.Message:
// Work with the message
await HandleMessage(update);
break;
case UpdateType.CallbackQuery:
// Handle button click
await bot.Message.AnswerCallback(update.CallbackQuery!.Id);
await HandleCallback(update);
break;
// Other event types...
}
}
ErrorHandler Handles all API errors:
async Task ErrorHandler(Exception exception, Update? update)
{
// Log the error
Console.WriteLine($"Error: {exception}");
}
Working with requests
// Simple text
await bot.Message.SendText(chatId, "Hello!");
// With formatting
await bot.Message.SendText(
chatId: chatId,
text: "*Bold text* and `code`",
parseMode: ParseMode.Markdown,
keyboard: InlineKeyboard.Create()
.Row(InlineButton.CreateUrl("Link", "https://github.com/AQSIDE"))
.Row(InlineButton.CreateData("Button 1", "btn1"), InlineButton.CreateData("Button 2", "btn1"))
.Build(),
lifeTime: TimeSpan.FromSeconds(30) // Self-deletion in 30 seconds
);
// Photo with caption
await bot.Message.SendMedia(
chatId: chatId,
file: InputFile.FromUrl(InputFileType.Photo, "https://example.com/photo.jpg"),
text: "My photo 📸",
keyboard: InlineKeyboard.Create()
.Row(InlineButton.CreateData("👍", "like"), InlineButton.CreateData("👎", "dislike"))
.Build(),
// Direct API requests
var result = await bot.Message.SendRequest<Message>(
method: TelegramMethods.SEND_MESSAGE,
body: new
{
chat_id = chatId,
photo = "https://example.com/photo.jpg",
caption = "Photo via direct request",
reply_markup = new { inline_keyboard = new[] { new[] { new { text = "Test", callback_data = "test" } } } }
}
);
if (result.Ok)
{
Console.WriteLine($"Message sent with ID: {result.Result!.MessageId}");
}
// Deletion
bool success = await bot.Message.DeleteMessage(chatId, messageId);
Advanced architecture
async Task UpdateHandler(Update update)
{
// Create context
var context = CreateContext(update);
if (context == null) return;
var user = context.User;
// Update user activity
_activityService.UpdateUserActivity(user);
// Answer callback to remove "loading"
if (update.Type == UpdateType.CallbackQuery)
{
await bot.Message.AnswerCallback(update.CallbackQuery!.Id);
}
// Route the request further
await _routerManager.Route(context);
}
private UserContext? CreateContext(Update update)
{
if (update.GetFrom == null) return null;
return new UserContext
{
UserId = update.GetFrom.Id,
ChatId = update.GetChat?.Id ?? update.GetFrom.Id,
Update = update,
UserData = _userRepository.Get(update.GetFrom.Id)
};
}
Configuration
bot = new TelegramBot(new BotOptions(
"YOUR_TOKEN",
allowedUpdates: new[]
{
UpdateType.Message,
UpdateType.CallbackQuery,
},
defaultParseMode: ParseMode.HTML)
{
Offset = 0, // From which update to start
Timeout = 30, // Long polling timeout in seconds
});
// Message deletion time (Lifetime) configuration
_bot.Options.Lifetime = new LifetimeOptions(new LifetimeModule(bot, bot.MainLoop));
// Subscribe to Lifetime events
bot.Options.Lifetime.Module.OnAdd = OnAdd;
bot.Options.Lifetime.Module.OnDelete = OnDelete;
// Request limiting (Rate Limiting) configuration
bot.Options.RateLimit = new RateLimitOptions( new RateLimiter(
requestsPerSecond: 20, // 20 requests per second
maxBurstSize: 25 // Maximum burst
)
);
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. 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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.