Merge branch 'development' of https://github.com/MajMcCloud/TelegramBotFramework into development

TelegramBotBase/Builder/Interfaces/IAPIKeySelectionStage.cs

@@ -0,0 +1,45 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TelegramBotBase.Form;
+using TelegramBotBase.Interfaces;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface IAPIKeySelectionStage
+    {
+        /// <summary>
+        /// Sets the API Key which will be used by the telegram bot client.
+        /// </summary>
+        /// <param name="apiKey"></param>
+        /// <returns></returns>
+        IMessageLoopSelectionStage WithAPIKey(String apiKey);
+
+
+        /// <summary>
+        /// Quick and easy way to create a BotBase instance.
+        /// Uses: DefaultMessageLoop, NoProxy, OnlyStart, NoSerialization, DefaultLanguage
+        /// </summary>
+        /// <param name="apiKey"></param>
+        /// <param name="StartForm"></param>
+        /// <returns></returns>
+        IBuildingStage QuickStart(String apiKey, Type StartForm);
+
+        /// <summary>
+        /// Quick and easy way to create a BotBase instance.
+        /// Uses: DefaultMessageLoop, NoProxy, OnlyStart, NoSerialization, DefaultLanguage
+        /// </summary>
+        /// <param name="apiKey"></param>
+        /// <returns></returns>
+        IBuildingStage QuickStart<T>(String apiKey) where T : FormBase;
+
+        /// <summary>
+        /// Quick and easy way to create a BotBase instance.
+        /// Uses: DefaultMessageLoop, NoProxy, OnlyStart, NoSerialization, DefaultLanguage
+        /// </summary>
+        /// <param name="apiKey"></param>
+        /// <param name="StartFormFactory"></param>
+        /// <returns></returns>
+        IBuildingStage QuickStart(String apiKey, IStartFormFactory StartFormFactory);
+    }
+}

TelegramBotBase/Builder/Interfaces/IBotCommandsStage.cs

@@ -0,0 +1,39 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Telegram.Bot.Types;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface IBotCommandsStage
+    {
+        /// <summary>
+        /// Does not create any commands.
+        /// </summary>
+        /// <returns></returns>
+        ISessionSerializationStage NoCommands();
+
+
+        /// <summary>
+        /// Creates default commands for start, help and settings.
+        /// </summary>
+        /// <returns></returns>
+        ISessionSerializationStage DefaultCommands();
+
+
+        /// <summary>
+        /// Only adds the start command.
+        /// </summary>
+        /// <returns></returns>
+        ISessionSerializationStage OnlyStart();
+
+
+        /// <summary>
+        /// Gives you the ability to add custom commands.
+        /// </summary>
+        /// <param name="action"></param>
+        /// <returns></returns>
+        ISessionSerializationStage CustomCommands(Action<List<BotCommand>> action);
+
+    }
+}

TelegramBotBase/Builder/Interfaces/IBuildingStage.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface IBuildingStage
+    {
+        BotBase Build();
+    }
+}

TelegramBotBase/Builder/Interfaces/ILanguageSelectionStage.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TelegramBotBase.Localizations;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface ILanguageSelectionStage
+    {
+
+        /// <summary>
+        /// Selects the default language for control usage. (English)
+        /// </summary>
+        /// <returns></returns>
+        IBuildingStage DefaultLanguage();
+
+        /// <summary>
+        /// Selects english as the default language for control labels.
+        /// </summary>
+        /// <returns></returns>
+        IBuildingStage UseEnglish();
+
+        /// <summary>
+        /// Selects german as the default language for control labels.
+        /// </summary>
+        /// <returns></returns>
+        IBuildingStage UseGerman();
+
+        /// <summary>
+        /// Selects a custom language as the default language for control labels.
+        /// </summary>
+        /// <returns></returns>
+        IBuildingStage Custom(Localization language);
+
+    }
+}

TelegramBotBase/Builder/Interfaces/INetworkingSelectionStage.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Collections.Generic;
+using System.Net.Http;
+using System.Text;
+using Telegram.Bot;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface INetworkingSelectionStage
+    {
+
+        /// <summary>
+        /// Chooses a proxy as network configuration.
+        /// </summary>
+        /// <param name="proxyAddress"></param>
+        /// <returns></returns>
+        IBotCommandsStage WithProxy(String proxyAddress);
+
+        /// <summary>
+        /// Do not choose a proxy as network configuration.
+        /// </summary>
+        /// <returns></returns>
+        IBotCommandsStage NoProxy();
+
+
+        /// <summary>
+        /// Chooses a custom instance of TelegramBotClient.
+        /// </summary>
+        /// <param name="client"></param>
+        /// <returns></returns>
+        IBotCommandsStage WithBotClient(TelegramBotClient client);
+
+
+        /// <summary>
+        /// Sets the custom proxy host and port.
+        /// </summary>
+        /// <param name="proxyHost"></param>
+        /// <param name="Port"></param>
+        /// <returns></returns>
+        IBotCommandsStage WithHostAndPort(String proxyHost, int Port);
+
+        /// <summary>
+        /// Uses a custom http client.
+        /// </summary>
+        /// <param name="client"></param>
+        /// <returns></returns>
+        IBotCommandsStage WithHttpClient(HttpClient client);
+
+
+    }
+}

TelegramBotBase/Builder/Interfaces/ISessionSerializationStage.cs

@@ -0,0 +1,49 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TelegramBotBase.Interfaces;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface ISessionSerializationStage
+    {
+        /// <summary>
+        /// Do not uses serialization.
+        /// </summary>
+        /// <returns></returns>
+        ILanguageSelectionStage NoSerialization();
+
+
+        /// <summary>
+        /// Sets the state machine for serialization.
+        /// </summary>
+        /// <param name="machine"></param>
+        /// <returns></returns>
+        ILanguageSelectionStage UseSerialization(IStateMachine machine);
+
+
+        /// <summary>
+        /// Using the complex version of .Net JSON, which can serialize all objects.
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns></returns>
+        ILanguageSelectionStage UseJSON(String path);
+
+
+        /// <summary>
+        /// Use the easy version of .Net JSON, which can serialize basic types, but not generics and others.
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns></returns>
+        ILanguageSelectionStage UseSimpleJSON(String path);
+
+
+        /// <summary>
+        /// Uses the XML serializer for session serialization.
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns></returns>
+        ILanguageSelectionStage UseXML(String path);
+
+    }
+}

TelegramBotBase/Builder/Interfaces/IStartFormSelectionStage.cs

@@ -0,0 +1,34 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TelegramBotBase.Form;
+using TelegramBotBase.Interfaces;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface IStartFormSelectionStage
+    {
+
+        /// <summary>
+        /// Chooses a start form type which will be used for new sessions.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <returns></returns>
+        INetworkingSelectionStage WithStartForm(Type startFormClass);
+
+        /// <summary>
+        /// Chooses a generic start form which will be used for new sessions.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <returns></returns>
+        INetworkingSelectionStage WithStartForm<T>() where T : FormBase, new();
+
+        /// <summary>
+        /// Chooses a StartFormFactory which will be use for new sessions.
+        /// </summary>
+        /// <param name="factory"></param>
+        /// <returns></returns>
+        INetworkingSelectionStage WithStartFormFactory(IStartFormFactory factory);
+
+    }
+}