WM.MessengersForms 8.9.2

WM.MessengersForms

Опис

WM.MessengersForms — це бібліотека для створення інтерфейсів користувача для месенджерів. Вона дозволяє будувати екрани, повідомлення, кнопки, поля введення та багато іншого. Ви можете серіалізувати ці елементи у формати, що підтримуються популярними платформами, та створювати ланцюжки екранів за допомогою білдера.

Встановлення

Додайте пакет до вашого проекту за допомогою NuGet:

dotnet add package WM.MessengersForms

Приклади використання

Створення базових елементів

Приклад створення повідомлення, кнопки та поля введення:

using WM.MessengersForms.Elements;

var msg = new Message(new MessageOptions())
{
    Title = "HELLO WORLD TITLE",
    Text = "just hello world message",
    Order = 1,
    Id = 1
};

var btn = new Button(new ButtonOptions())
{
    Text = "Test btn",
    SubText = "Test sub btn text",
    Action = "TestAction",
    Id = 2,
    Order = 2
};

var phoneInput = new PhoneInput(new TextInputOptions()
{
    Color = "RED",
    InputTextStyle = "BOLD"
})
{
    Id = 3,
    Order = 3,
    PlaceHolder = "+38(068)000-00-00"
};

var screen = new Screen();
screen.AddElement(msg);
screen.AddElement(btn);
screen.AddElement(phoneInput);

var result = screen.ToMessengerFormat(MessengerFormat.Widget);
Console.WriteLine(result);

Приклад використання Builder для створення ланцюжків екранів

За допомогою Builder можна створювати складні інтерфейси:

using WM.MessengersForms.Chains;

var chain = new ChainController();

chain.CreateScreen("MainScreen", 0, true)
     .CreateButton("Button1", 1, 100, null, b => b
         .SetColor("red")
         .SetIcon("icon.png")
         .SetSubText("This is button 1"))
     .CreateButton("Button2", 2, 2, null, b => b
         .SetColor("blue")
         .SetImage("image.jpg"))
     .CreateMessage("message in mainscreen", 3, 3, m => m
         .SetTitle("TEST MESSAGE TITLE")
         .SetPhotoUrl("/photo.jpeg")
         .SetColor("RED").SetStyle("BOLD"))
     .AddChainLink("Акції");

chain.CreateScreen("SecondaryScreen", 1)
     .CreateButton("Back", 3, 1, "act:back_action", b => b
         .SetColor("green")
         .SetIcon("back_icon.png"))
     .AddChainLink("act:secondary_screen");

var mainScreen = chain.GetScreenByAction("Акції");
var secondaryScreen = chain.GetScreenByAction("act:secondary_screen");

Console.WriteLine(mainScreen.ToMessengerFormat(MessengerFormat.Widget));
Console.WriteLine(secondaryScreen.ToMessengerFormat(MessengerFormat.Widget));

Експорт та імпорт ланцюжків

Ланцюжки екранів можна експортувати та імпортувати:

var exportedData = chain.ExportChain();
Console.WriteLine(exportedData);

var newChain = ChainController.ImportChain(exportedData);
Console.WriteLine(newChain.GetScreenByAction("Акції").ToMessengerFormat(MessengerFormat.Widget));

Кастомна серіалізація

Ви можете додати власну логіку серіалізації, створивши клас, що реалізує інтерфейс IElementSerializer<T>:

public class CustomTelegramSerializer : IElementSerializer<TelegramMessageData>
{
    public TelegramMessageData Serialize(IDrawableElement element)
    {
        var model = (ISerializationModel)element.GetSerializationModel();

        switch (model.Type)
        {
            case "Screen":
                return ModelToTelegramSessage(model, 123);
            default:
                throw new NotSupportedException($"Type: {model.Type} not supported");
        }
    }

    private TelegramMessageData ModelToTelegramSessage(ISerializationModel model, long chatId)
    {
        ScreenSerializationModel screen = (ScreenSerializationModel) model;

        var serializationModels = screen.Elements.Cast<ISerializationModel>();
        var buttons = serializationModels
            .Where(sm => sm.Type.Equals(ElementType.Button.ToString()))
            .Cast<ButtonWidgetModel>().ToList();

        var message = (MessageSerializationModel)serializationModels
            .FirstOrDefault(sm => sm.Type.Equals(ElementType.Message.ToString()));

        var tgButtons = buttons.Select(b => new TelegramButton(b.Text, b.Action));

        return new TelegramMessageData(message?.Text, message?.PhotoUrl, null, chatId, tgButtons);
    }
}

Основні класи

• Message: використовується для створення повідомлень.
• Button: створення кнопок із текстом, підписами та діями.
• PhoneInput: поле введення номеру телефону.
• Screen: екран, який об’єднує елементи.
• ChainController: менеджер ланцюжків екранів.
• IElementSerializer: інтерфейс для серіалізації елементів.

Формати серіалізації

MessengerFormat.Widget

Серіалізація елементів у формат для віджетів месенджерів.

Кастомна серіалізація

Реалізуйте власний формат за допомогою інтерфейсу IElementSerializer<T>.

Ліцензія

WM.MessengersForms розповсюджується під ліцензією MIT License.