kosyakmakc/TelegramBotFramework
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
FlorianDahn 2021-10-17 18:31:28 +02:00
parent d00c5e1799
commit e1d5051288
1 changed files with 60 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
README.md
View File

@ -143,11 +143,19 @@ It needs to be a subclass of "FormBase" you will find in Namespace TelegramBotBa
``` ```
//Prepare the System //Prepare the System (New in V5)
BotBase<StartForm> bb = new BotBase<StartForm>("{YOUR API KEY}"); var bb = BotBaseBuilder
.Create()
.WithAPIKey("{YOUR API KEY}")
.WithStartForm<StartForm>()
.NoProxy()
.Configure(a =>
{
a.AddStartCommand("Starts the bot")
//Add Systemcommands if you like, you could catch them later })
bb.BotCommands.Add(new BotCommand() { Command = "start", Description = "Starts the bot" }); .NoSerialization()
.Build();
//Update bot commands to botfather //Update bot commands to botfather
bb.UploadBotCommands().Wait(); bb.UploadBotCommands().Wait();
@ -252,12 +260,22 @@ Below we have 4 options.
``` ```
BotBase<Start> bb = new BotBase<Start>("{YOUR API KEY}"); var bb = BotBaseBuilder
.Create()
.WithAPIKey("{YOUR API KEY}")
.WithStartForm<Start>()
.NoProxy()
.Configure(a =>
{
a.AddStartCommand("Starts the bot");
a.Add(new BotCommand() { Command = "form1", Description = "Opens test form 1" });
a.Add(new BotCommand() { Command = "form2", Description = "Opens test form 2" });
a.Add(new BotCommand() { Command = "params", Description = "Returns all send parameters as a message." });
bb.BotCommands.Add(new BotCommand() { Command = "start", Description = "Starts the bot" });
bb.BotCommands.Add(new BotCommand() { Command = "form1", Description = "Opens test form 1" }); })
bb.BotCommands.Add(new BotCommand() { Command = "form2", Description = "Opens test form 2" }); .NoSerialization()
bb.BotCommands.Add(new BotCommand() { Command = "params", Description = "Returns all send parameters as a message." }); .Build();
bb.BotCommand += async (s, en) => bb.BotCommand += async (s, en) =>
{ {
@ -963,13 +981,17 @@ In general you didn't need to do more then, to keep the actual form:
``` ```
//Prepare the System //Prepare the System
BotBase<StartForm> bb = new BotBase<StartForm>("{YOUR API KEY}"); var bb = BotBaseBuilder
.Create()
//Add Systemcommands if you like, you could catch them later .WithAPIKey("{YOUR API KEY}")
bb.SystemCalls.Add("/start"); .WithStartForm<StartForm>()
.NoProxy()
//Set the statemachine and enable it .Configure(a =>
bb.StateMachine = new TelegramBotBase.States.SimpleJSONStateMachine(AppContext.BaseDirectory + "config\\states.json"); {
a.AddStartCommand("Starts the bot");
})
.UseSerialization(new TelegramBotBase.States.SimpleJSONStateMachine(AppContext.BaseDirectory + "config\\states.json"))
.Build();
//Start your Bot //Start your Bot
bb.Start(); bb.Start();
@ -982,13 +1004,17 @@ In general you didn't need to do more then, to keep the actual form:
``` ```
//Prepare the System //Prepare the System
BotBase<StartForm> bb = new BotBase<StartForm>("{YOUR API KEY}"); var bb = BotBaseBuilder
.Create()
//Add Systemcommands if you like, you could catch them later .WithAPIKey("{YOUR API KEY}")
bb.SystemCalls.Add("/start"); .WithStartForm<StartForm>()
.NoProxy()
//Set the statemachine and enable it .Configure(a =>
bb.StateMachine = new TelegramBotBase.States.JSONStateMachine(AppContext.BaseDirectory + "config\\states.json"); {
a.AddStartCommand("Starts the bot");
})
.UseSerialization(new TelegramBotBase.States.JSONStateMachine(AppContext.BaseDirectory + "config\\states.json"))
.Build();
//Start your Bot //Start your Bot
bb.Start(); bb.Start();
@ -1002,13 +1028,17 @@ In general you didn't need to do more then, to keep the actual form:
``` ```
//Prepare the System //Prepare the System
BotBase<StartForm> bb = new BotBase<StartForm>("{YOUR API KEY}"); var bb = BotBaseBuilder
.Create()
//Add Systemcommands if you like, you could catch them later .WithAPIKey("{YOUR API KEY}")
bb.SystemCalls.Add("/start"); .WithStartForm<StartForm>()
.NoProxy()
//Set the statemachine and enable it .Configure(a =>
bb.StateMachine = new TelegramBotBase.States.XMLStateMachine(AppContext.BaseDirectory + "config\\states.xml"); {
a.AddStartCommand("Starts the bot");
})
.UseSerialization(new TelegramBotBase.States.XMLStateMachine(AppContext.BaseDirectory + "config\\states.xml"))
.Build();
//Start your Bot //Start your Bot
bb.Start(); bb.Start();