Skip to content

docs: align samples with the 1.0 API #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
prethink merged 1 commit into from
Aug 23, 2026
Merged

docs: align samples with the 1.0 API #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/klassy/tcommands/pagetcommand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ using PRTelegramBot.Models.CallbackCommands;
using PRTelegramBot.Models.Enums;
using System.Text.Json.Serialization;

namespace PRTelegramBot.Models.TCommands
namespace PRTelegramBot.Models.CallbackCommands
{
/// <summary>
/// Обработка TCommand в формате страницы.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/metody-rasshireniya/messageextension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ public static async Task AutoEditMessage(this Message message, string messageTex
/// <param name="seconds">Через сколько секунд будет удалено сообщение.</param>
/// <param name="botClient">Бот клиент.</param>
/// <param name="update">Update.</param>
public static async Task AutoEditMessageСycle(this Message message, List<string> messageTexts, int seconds, ITelegramBotClient botClient, Update update)
public static async Task AutoEditMessageCycle(this Message message, List<string> messageTexts, int seconds, ITelegramBotClient botClient, Update update)
```
2 changes: 1 addition & 1 deletion docs/api/utils/messageawaiter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ namespace ConsoleExample.Examples
{
// Симуляция тяжелой операции.
await Task.Delay(2000);
await PRTelegramBot.Helpers.Message.Send(context, $"Генерация данных завершена.");
await MessageSender.Send(context, $"Генерация данных завершена.");
}
}
}
Expand Down
14 changes: 7 additions & 7 deletions docs/dependency-injection/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,13 @@ public async Task Название метода(IBotContext context)
[ReplyMenuHandler("Test")]
public async Task TestMethod(IBotContext context)
{
await PRTelegramBot.Helpers.Message.Send(context, $"{nameof(TestMethod)} {_logger != null}");
await MessageSender.Send(context, $"{nameof(TestMethod)} {_logger != null}");
}

[SlashHandler("/test")]
public async Task Slash(IBotContext context)
{
await PRTelegramBot.Helpers.Message.Send(context, nameof(Slash));
await MessageSender.Send(context, nameof(Slash));
}

[ReplyMenuHandler("inline")]
Expand All @@ -103,7 +103,7 @@ public async Task Название метода(IBotContext context)
new InlineCallback("TestStatic", THeader.NextPage)
});
options.MenuInlineKeyboardMarkup = MenuGenerator.InlineKeyboard(menuItemns);
await PRTelegramBot.Helpers.Message.Send(context, nameof(InlineTest), options);
await MessageSender.Send(context, nameof(InlineTest), options);
}

[ReplyMenuHandler("inlinestatic")]
Expand All @@ -115,25 +115,25 @@ public async Task Название метода(IBotContext context)
new InlineCallback("TestStatic", THeader.NextPage)
});
options.MenuInlineKeyboardMarkup = MenuGenerator.InlineKeyboard(menuItemns);
await PRTelegramBot.Helpers.Message.Send(context, nameof(StaticInlineTest), options);
await MessageSender.Send(context, nameof(StaticInlineTest), options);
}

[InlineCallbackHandler&#x3C;THeader>(THeader.CurrentPage)]
public async Task InlineHandler(IBotContext context)
{
await PRTelegramBot.Helpers.Message.Send(context, nameof(InlineHandler));
await MessageSender.Send(context, nameof(InlineHandler));
}

[InlineCallbackHandler&#x3C;THeader>(THeader.NextPage)]
public async static Task InlineHandlerStatic(IBotContext context)
{
await PRTelegramBot.Helpers.Message.Send(context, nameof(InlineHandlerStatic));
await MessageSender.Send(context, nameof(InlineHandlerStatic));
}

[ReplyMenuHandler("Test1")]
public async static Task StaticTestMethod(IBotContext context)
{
await PRTelegramBot.Helpers.Message.Send(context, nameof(StaticTestMethod));
await MessageSender.Send(context, nameof(StaticTestMethod));
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/dobavlenie-i-udalenie-komand-v-dinamicheskom-rezhime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: >-
var method = async (IBotContext context) =>
{
string message = "Сообщение";
PRTelegramBot.Helpers.Message.Send(context, message);
MessageSender.Send(context, message);
};
```

Expand Down
2 changes: 1 addition & 1 deletion docs/fishki-poleznye-praktiki/rabota-s-komandami.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
public static async Task ReplyExampleAllBots(IBotContext context)
{
string msg = nameof(ReplyExampleAllBots);
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/fishki-poleznye-praktiki/sozdanie-komandy-tolko-dlya-administratorov.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ namespace ConsoleExample.Checkers
{
var userIsAdmin = await context.IsAdmin(update.GetChatId());
if(!userIsAdmin)
await PRTelegramBot.Helpers.Message.Send(context, "Вы не админ!");
await MessageSender.Send(context, "Вы не админ!");
// Пользователь админ возращаем результат Passed, что позволяет выполнить метод, иначе выполнение метода будет приостановлено.
return userIsAdmin ? InternalCheckResult.Passed : InternalCheckResult.Custom;
}
Expand Down Expand Up @@ -66,7 +66,7 @@ public static async Task AdminOnlyExample(IBotContext context)
{
bool isAdminUpdate = await context.IsAdmin(update);
bool isAdminById = await context.IsAdmin(update.GetChatId());
await PRTelegramBot.Helpers.Message.Send(context, $"Вы администратор бота: {isAdminById} {isAdminUpdate}");
await MessageSender.Send(context, $"Вы администратор бота: {isAdminById} {isAdminUpdate}");
}

```
Expand Down
10 changes: 5 additions & 5 deletions docs/obrabotka-komand/obrabotka-inline-komand/inlinecallback-s-podtverzhdeniem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
public static async Task InlineConfirm(IBotContext context)
{
//Кнопка для которой нужно создать подтверждение.
var exampleInlineCallback = new InlineCallback<EntityTCommand<long>>("Кнопка с подтвержением", CustomTHeaderTwo.ExampleThree, new EntityTCommand<long>(3, ActionWithLastMessage.Delete));
var exampleInlineCallback = new InlineCallback<EntityTCommand<long>>("Кнопка с подтвержением", CustomTHeaderTwo.ExampleTwo, new EntityTCommand<long>(3, ActionWithLastMessage.Delete));
//Обертка кнопки.
var exampleWithConfirmation = new InlineCallbackWithConfirmation(exampleInlineCallback, ActionWithLastMessage.Delete);

Expand All @@ -30,7 +30,7 @@ public static async Task InlineConfirm(IBotContext context)
option.MenuInlineKeyboardMarkup = testMenu;
string msg = "InlineCallback с подтверждением";
//Отправка сообщение с меню
await PRTelegramBot.Helpers.Message.Send(context, msg, option);
await MessageSender.Send(context, msg, option);
}
```

Expand All @@ -54,7 +54,7 @@ public static async Task InlineConfirm(IBotContext context)
public static async Task InlineConfirmWithBack(IBotContext context)
{
//Кнопка для которой нужно создать подтверждение.
var exampleInlineCallback = new InlineCallback<EntityTCommand<long>>("Кнопка с подтвержением", CustomTHeaderTwo.ExampleThree, new EntityTCommand<long>(3, ActionWithLastMessage.Delete));
var exampleInlineCallback = new InlineCallback<EntityTCommand<long>>("Кнопка с подтвержением", CustomTHeaderTwo.ExampleTwo, new EntityTCommand<long>(3, ActionWithLastMessage.Delete));
//Кнопка обработчик назад или кастомная.
var exampleBack = new InlineCallback("Назад", CustomTHeaderTwo.ExampleBack);

Expand All @@ -71,9 +71,9 @@ public static async Task InlineConfirmWithBack(IBotContext context)
string msg = "InlineCallback с подтверждением и обработкой кнопки назад или кастомной";
//Отправка сообщение с меню
if(update.Type == Telegram.Bot.Types.Enums.UpdateType.CallbackQuery)
await PRTelegramBot.Helpers.Message.Edit(context, msg, option);
await MessageEditor.Edit(context, msg, option);
else
await PRTelegramBot.Helpers.Message.Send(context, msg, option);
await MessageSender.Send(context, msg, option);
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/obrabotka-komand/obrabotka-inline-komand/obrabotka-inline-komand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public static async Task Inline(IBotContext context)
if (command != null)
{
string msg = "Выполнена команда callback";
await PRTelegramBot.Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}
}

Expand All @@ -60,7 +60,7 @@ public static async Task InlineTwo(IBotContext context)
if (command != null)
{
string msg = $"Идентификатор который вы передали {command.Data.EntityId}";
await PRTelegramBot.Helpers.Message.Send(context);
await MessageSender.Send(context);
}

}
Expand Down
2 changes: 1 addition & 1 deletion docs/obrabotka-komand/obrabotka-inline-komand/sozdanie-inline-menyu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public class Commands
//Передача меню в настройки
option.MenuInlineKeyboardMarkup = testMenu;
string msg = "Пример работы меню";
await PRTelegramBot.Helpers.Message.Send(context, msg, option);
await MessageSender.Send(context, msg, option);
}
}
```
Expand Down
30 changes: 15 additions & 15 deletions docs/obrabotka-komand/obrabotka-slash-komand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ namespace ConsoleExample.Examples.Commands
"\n /get_2 - команда 2" +
"\n /get_3 - команда 3" +
"\n /get_4 - команда 4";
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}

/// <summary>
Expand All @@ -83,20 +83,20 @@ namespace ConsoleExample.Examples.Commands
// Нет аргументов
if (args.Count == 0)
{
await Helpers.Message.Send(context, "Команда /get");
await MessageSender.Send(context, "Команда /get");
return;
}

// Один аргумент
if (args.Count == 1)
{
await Helpers.Message.Send(context, $"Команда /get со значением: {args[0]}");
await MessageSender.Send(context, $"Команда /get со значением: {args[0]}");
return;
}

// Несколько аргументов
string joinedArgs = string.Join(", ", args);
await Helpers.Message.Send(context, $"Команда /get со значениями: {joinedArgs}");
await MessageSender.Send(context, $"Команда /get со значениями: {joinedArgs}");
}

/// <summary>
Expand All @@ -112,20 +112,20 @@ namespace ConsoleExample.Examples.Commands
// Нет аргументов
if (args.Count == 0)
{
await Helpers.Message.Send(context, "Команда /int");
await MessageSender.Send(context, "Команда /int");
return;
}

// Один аргумент
if (args.Count == 1)
{
await Helpers.Message.Send(context, $"Команда /int со значением: {args[0]}");
await MessageSender.Send(context, $"Команда /int со значением: {args[0]}");
return;
}

// Несколько аргументов
string joinedArgs = string.Join(", ", args);
await Helpers.Message.Send(context, $"Команда /int со значениями: {joinedArgs}");
await MessageSender.Send(context, $"Команда /int со значениями: {joinedArgs}");
}

/// <summary>
Expand All @@ -141,20 +141,20 @@ namespace ConsoleExample.Examples.Commands
// Нет аргументов
if (args.Count == 0)
{
await Helpers.Message.Send(context, "Команда /bool");
await MessageSender.Send(context, "Команда /bool");
return;
}

// Один аргумент
if (args.Count == 1)
{
await Helpers.Message.Send(context, $"Команда /bool со значением: {args[0]}");
await MessageSender.Send(context, $"Команда /bool со значением: {args[0]}");
return;
}

// Несколько аргументов
string joinedArgs = string.Join(", ", args);
await Helpers.Message.Send(context, $"Команда /bool со значениями: {joinedArgs}");
await MessageSender.Send(context, $"Команда /bool со значениями: {joinedArgs}");
}

/// <summary>
Expand All @@ -169,12 +169,12 @@ namespace ConsoleExample.Examples.Commands
if (args.Count > 0)
{
string msgWithArgs = $"Команда /start со значением {args[0]}";
await Helpers.Message.Send(context, msgWithArgs);
await MessageSender.Send(context, msgWithArgs);
return;
}

string msg = $"Команда /start";
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}

/// <summary>
Expand All @@ -186,7 +186,7 @@ namespace ConsoleExample.Examples.Commands
public static async Task ExampleSlashEqualsCommand(IBotContext context)
{
string msg = nameof(ExampleSlashEqualsCommand);
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}

/// <summary>
Expand All @@ -198,7 +198,7 @@ namespace ConsoleExample.Examples.Commands
public static async Task ExampleSlashEqualsRegisterCommand(IBotContext context)
{
string msg = nameof(ExampleSlashEqualsRegisterCommand);
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}
}
}
Expand All @@ -222,7 +222,7 @@ public class Commands
public static async Task ExampleReply(IBotContext context)
{
string msg = "Бот: ответ бота тест";
await PRTelegramBot.Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}
}
```
10 changes: 5 additions & 5 deletions docs/obrabotka-komand/obrabotka-soobshenii-polzovatelya-reply/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public class Commands
public static async Task ReplyExampleOne(IBotContext context)
{
string msg = nameof(ReplyExampleOne);
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}

/// <summary>
Expand All @@ -65,7 +65,7 @@ public class Commands
public static async Task ReplyExampleTwo(IBotContext context)
{
string msg = nameof(ReplyExampleTwo);
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}

/// <summary>
Expand All @@ -77,7 +77,7 @@ public class Commands
public static async Task ExampleReplyMany(IBotContext context)
{
string msg = nameof(ExampleReplyMany);
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}

/// <summary>
Expand All @@ -89,7 +89,7 @@ public class Commands
public static async Task ExampleReplyBotIdOne(IBotContext context)
{
string msg = nameof(ExampleReplyBotIdOne);
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}

/// <summary>
Expand All @@ -100,7 +100,7 @@ public class Commands
public static async Task ReplyExampleAllBots(IBotContext context)
{
string msg = nameof(ReplyExampleAllBots);
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}
}
```
2 changes: 1 addition & 1 deletion ...otka-soobshenii-polzovatelya-reply/dinamicheskie-reply-komandy-iz-json-faila.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public static async Task ExampleReplyDynamicCommand(IBotContext context)
*/

string msg = nameof(ExampleReplyDynamicCommand);
await Helpers.Message.Send(context, msg);
await MessageSender.Send(context, msg);
}

```
Expand Down
4 changes: 2 additions & 2 deletions ...brabotka-komand/obrabotka-soobshenii-polzovatelya-reply/sozdanie-reply-menyu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ _**Даже если вы укажите одновременно MenuReplyKeybo
* resizeKeyboard – флаг **resize** из telegram api.
* mainMenu – если не пустой, добавляет в конце меню пункт простой кнопки. (Например может использоваться для показа кнопки “Главное меню”).

**PRTelegramBot.Helpers.Message.Send** – вспомогательный метод обертка над Telegram.Bot. Может принимать помимо самого сообщения еще и параметры с помощью OptionMessage. Так же если размер сообщения будет больше 4000 символов, разделит текст на несколько сообщений.
**PRTelegramBot.Services.Messages.MessageSender.Send** – вспомогательный метод обертка над Telegram.Bot. Может принимать помимо самого сообщения еще и параметры с помощью OptionMessage. Так же если размер сообщения будет больше 4000 символов, разделит текст на несколько сообщений.

Пример с комментариями простого меню представлен ниже

Expand Down Expand Up @@ -61,7 +61,7 @@ public static async Task ExampleReplyMenu(IBotContext context)
var menu = MenuGenerator.ReplyKeyboard(1, menuList, true, "Главное меню");
//Добавляем в настройки меню
option.MenuReplyKeyboardMarkup = menu;
await PRTelegramBot.Helpers.Message.Send(context, msg, option);
await MessageSender.Send(context, msg, option);
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/obrabotka-komand/rabota-s-kalendarem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public static async Task PickDate(IBotContext context)
using (var inlineHandler = new InlineCallback&#x3C;CalendarTCommand>(botClient, update))
{
var command = inlineHandler.GetCommandByCallbackOrNull();
await Helpers.Message.Send(botClient, update, command.Data.Date.ToString());
await MessageSender.Send(botClient, update, command.Data.Date.ToString());
}
}
catch (Exception ex)
Expand Down
Loading
Loading