Discord.InteractivityAddon 1.2.3

Discord.InteractivityAddon

This is an addon for the Discord API Wrapper Discord.Net which makes it easy to add interactivity to your discord bot.

Credits

• The package has been created with the support of TwentyFourMinutes. Check out his UtilityAddon which provides some great features for your bot 😃
• The criterion system is inspired by foxbot's Discord.Addons.Interactive package.

Features

• Waiting for a specific message or reaction using a powerful criteria system
• Applying a custom action to every message / reaction which passes your criteria
• Send and delete messages & files with delays
• A powerful Paginator
• Selection from a custom list of objects
• Confirmation of an action
• Uptime counter

Usage

To use this addons features you need to add an InteractivityService to your service provider.

var provider = new ServiceCollection()
                .AddSingleton(Client)
                .AddSingleton(CommandService)
                .AddSingleton(new InteractivityService(Client, TimeSpan.FromMinutes(3)))

This addon does not include a custom ModuleBase in order to support every command framework. (Discord.Net.Command/Qmmands/...)

Example Selection Command

[Command("select")]
public async Task ExampleSelectionAsync()
{
    var builder = new SelectionBuilder<string>()
                    .WithSettings(allowCancel: true)
                    .WithUsers(Context.User)
                    .WithValues(new[] { "Hi", "How", "Hey", "Huh?!" })
                    .WithAppearance(SelectionAppearanceBuilder.Default
                    .WithSettings(deleteSelectionAfterCapturedResult: true));
    
    //Note that the selection will not return the original ref but a clone!
    var result = await _interactivity.GetUserSelectionAsync(builder.Build(), Context.Channel, TimeSpan.FromSeconds(50));

    if (result.IsSuccess == true) {
        await Context.Channel.SendMessageAsync(result.Value);
    }
}

Example Paginator Command

[Command("paginator")]
public async Task ExamplePaginatorAsync()
{
    var pages = new List<Embed>() {
        new EmbedBuilder().WithTitle("I").Build(),
        new EmbedBuilder().WithTitle("am").Build(),
        new EmbedBuilder().WithTitle("cool").Build(),
        new EmbedBuilder().WithTitle(":sunglasses: ").Build(),
    };

    var paginator = new PaginatorBuilder()
        .WithEmbeds(pages.ToArray())
        .WithUsers(Context.User)
        .WithPaginatorFooter(PaginatorFooter.PageNumber | PaginatorFooter.Users)
        .Build();

    await _interactivity.SendPaginatorAsync(paginator, Context.Channel, TimeSpan.FromMinutes(2));
}

Example Confirmation Command

[Command("confirm")]
public async Task ExampleConfirmationAsync()
{
    var message = await Context.Channel.SendMessageAsync("Please confirm!");
    var request = new ConfirmationRequest(message, Context.User.Id);

    var result = await _interactivity.GetUserConfirmationAsync(request);

    if (result.Value == true) {
        await message.ModifyAsync(x => x.Content = "Confirmed :thumbsup:!");
    }
}