nyxx_extensions 2.0.0-rc.9

Nyxx Extensions Module. Discord library for Dart. Simple, robust framework for creating discord bots for Dart language.

example/example.dart

import "package:nyxx/nyxx.dart";
import "package:nyxx_extensions/emoji.dart" as emoji_extension;
import "package:nyxx_extensions/pagination.dart" as pagination_extension;
import "package:nyxx_extensions/src/message_resolver/message_resolver.dart" as message_resolver_extension;

// nyxx.extensions contains several different extensions
// that could simplify making and implementing bots.
void main() async {
  // Emoji extension would allow to download and fetch discord emoji definitions
  // from resource shared by Emzi.
  // Emoji utils can cache results to do not download json document each time
  final allEmojis = emoji_extension.getAllEmojiDefinitions();

  // Its also possible to filter the emojis based on predicate
  final filteredEmojis = emoji_extension.filterEmojiDefinitions(
          (emojiDefinition) => emojiDefinition.primaryName.startsWith("smile")
  );

  // Needed for next extension
  final bot = Nyxx("token", GatewayIntents.allUnprivileged);

  // Message Resolver extension allows to transform raw string message content
  // to format that user is seeing
  final messageResolver = message_resolver_extension.MessageResolver(bot);

  // resolve method will return message according to set handling settings in
  // MessageResolver constructor.
  final resolvedMessage = messageResolver.resolve("This is raw content. <!@123>");

  // Next extension if pagination handler which allow to create messages that can
  // have multiple pages of content and can be switched by "buttons".
  // To use that extension provide channel where paginated message will be sent
  // and implementation of IPaginationHandler.
  // nyxx_extensions provides few implementation of that interface which allows to
  // display basic text pages.
  final paginationChannel = await bot.fetchChannel<TextChannel>(Snowflake(123));
  final pages = [
    "this is one page",
    "this is second page",
    "this is third page",
  ];

  // Create instance of pagination and provide necessary arguments. Then use
  // .paginate method to send message and start listening to user actions.
  // Paginate returns message object of resulting message
  final paginator = pagination_extension.Pagination(
      paginationChannel,
      pagination_extension.BasicPaginationHandler(pages)
  );
  final resultingMessage = await paginator.paginate(bot);
}