SKitLs.Bots.Telegram.AdvancedMessages 3.0.3-alpha2

SKitLs.Bots.Telegram.AdvancedMessages

README version: 2023

An extension project built upon the SKitLs.Bots.Telegram.Core Framework.

Offers enhanced methods for sending messages in Telegram bots.

Description

SKitLs.Bots.Telegram.AdvancedMessages serves as an extension to the SKitLs.Bots.Telegram Framework, enriching the message-sending functionality in Telegram bots. The primary objective of this extension is to offer improved methods for message creation and delivery, thus enabling more flexible and interactive communication with users.

The key functionalities of this extension include:

1. Advanced Delivery:

   The AdvancedDeliverySystem is an enhanced implementation of the IDeliveryService interface, designed to facilitate seamless interaction with message classes within the library. Replacing the DefaultDeliverySystem, this feature introduces a more sophisticated and versatile approach to message handling.

2. Menus:

   The extension empowers the creation of messages with integrated inline menus, allowing users to interact with the bot seamlessly without leaving the chat window. Also you can augment messages with Reply Markups, presenting users with a set of buttons to choose from, leading to prompt responses and actions, thereby streamlining interactions.

3. Message Formatting (WIP):

   SKitLs.Bots.Telegram.AdvancedMessages provides the ability to format text messages with various styles, such as bold, italic, and stroke text. This enables more expressive and comprehensible presentation of textual information.

As part of the expansion plan, developers aim to introduce functionality for sending audio files, media, and documents. This enhancement will facilitate more efficient exchange of diverse content types between bots and users, elevating the quality and diversity of communication.

SKitLs.Bots.Telegram.AdvancedMessages is committed to empowering Telegram bot developers with tools to create more interactive, informative, and user-friendly messages, thereby enhancing the overall user experience and satisfaction.

Setup

Ensure getting localization packs (*.am.*).

Installation

1. Using Terminal Command:

   To install the project using the terminal command, follow these steps:

   1. Open the terminal or command prompt.
   2. Run command:

   dotnet add package SKitLs.Bots.Telegram.AdvancedMessages
   

2. Using NuGet Packages Manager:

   To install the project using the NuGet Packages Manager, perform the following steps:

   1. Open your preferred Integrated Development Environment (IDE) that supports NuGet package management (e.g., Visual Studio).
   2. Create a new project or open an existing one.
   3. Select "Project" > "Manage NuGet Packages"
   4. In the "Browse" tab, search for the project package you want to install.
   5. Click on the "Install" button to add the selected package to your project.
   6. Follow any additional setup instructions or configurations provided in the project's documentation.

3. Downloading Source Code and Direct Linking:

   To install the project by downloading the source code and directly linking it to your project, adhere to the following steps:

   1. Visit the project repository on GitHub
   2. Click on the "Code" button and select "Download ZIP" to download the project's source code as a zip archive.
   3. Extract the downloaded zip archive to the desired location on your local machine.
   4. Open your existing project or create a new one in your IDE.
   5. Add the downloaded project files to your solution using the "Add Existing Project" option in your IDE's solution explorer.
   6. Reference the project in your solution and ensure any required dependencies are resolved.
   7. Follow any additional setup or configuration instructions provided in the project's documentation.

Please note that each method may have specific requirements or configurations that need to be followed for successful installation. Refer to the project's documentation for any additional steps or considerations.

Usage

Update Delivery System

BotBuilder.NewBuilder()
    .CustomDelivery(new AdvancedDeliverySystem())
    .Build()
    .Listen();

Design your message

var mes = new OutputMessageText("Message with inline menu");

var menu = new InlineMenu();
menu.Add(someCallback);
menu.Add(new UrlButton("Href", "https://linktoyoursource.example");

mes.Menu = menu;

var mes = new OutputMessageText("Message with reply menu");

var menu = new ReplyMenu()
{
    ColumnsCount = 2,
};
menu.Add("Text instead of button");
menu.Add(new RelpyButton("Text but button"));
menu.Add(new RequestUserButton("Request User", 242085, true).OnlyUsers());

mes.Menu = menu;

Build content on context

var mes = new MultiblockMessage("display.localkey");
mes.ContentBuilder = Localize;

async Task<MultiblockMessage> Localize(MultiblockMessage sender, ICastedUpdate? update)
{
    var key = sender.GetBody();
    var text = update?.Owner.ResolveBotString(key) ?? key;
    return new MultiblockMessage(text);
}

Contributors

Currently, there are no contributors actively involved in this project. However, our team is eager to welcome contributions from anyone interested in advancing the project's development.

We value every contribution and look forward to collaborating with individuals who share our vision and passion for this endeavor. Your participation will be greatly appreciated in moving the project forward.

Thank you for considering contributing to our project.

License

This project is distributed under the terms of the MIT License.

Copyright (C) 2023-2024, SKitLs

Developer contact

For any issues related to the project, please feel free to reach out to us through the project's GitHub page. We welcome bug reports, feedback, and any other inquiries that can help us improve the project.

You can also contact the project owner directly via their GitHub profile at the following link or email: skitlsdev@gmail.com

Your collaboration and support are highly appreciated, and we will do our best to address any concerns or questions promptly and professionally. Thank you for your interest in our project.

Notes

Thank you for choosing our solution for your needs, and we look forward to contributing to your project's success.