nyxx_extensions library

Extensions and additional utilities for working with nyxx.

Classes

EmojiDefinition
Information about a text emoji.
GuildJoins
Provides a way to know when the client joins or leaves a Guild.
Pagination
A plugin that adds support for pagination to nyxx clients.
PaginationOptions
Options for controlling pagination.

Extensions

AuditLogManagerExtensions
Extensions on AuditLogManager.
ChannelExtensions
Extensions on Channels.
ChannelManagerExtensions
Extensions on ChannelManagers.
DateTimeExtensions
Extensions on DateTime.
DurationExtensions
Extensions on Duration.
EmbedExtensions
Extensions on Embed.
EntitlementManagerExtensions
Extensions on EntitlementManagers.
GuildCategoryExtensions
Extensions on GuildCategorys.
GuildChannelExtensions
Extensions on GuildChannels.
GuildExtensions
Extensions on Guilds.
GuildManagerExtensions
Extensions on GuildManagers.
ManagedSnowflakeEntityExtensions
Extensions on ManagedSnowflakeEntitys.
MemberManagerExtensions
Extensions on MemberManagers.
MessageExtensions
Extensions on Messages.
MessageManagerExtensions
Extensions on MessageManagers.
NyxxRestExtensions
Extensions on NyxxRest.
PartialChannelExtensions
Extensions on PartialChannels.
PartialGuildExtensions
Extensions on PartialGuilds.
PartialMemberExtensions
Extensions on PartialMembers.
PartialRoleExtensions
Extensions on PartialRoles.
PartialScheduledEventExtensions
Extensions on PartialScheduledEvent.
PartialUserExtensions
Extensions on PartialUser.
ScheduledEventManagerExtensions
Extensions on ScheduledEventManagers.
SnowflakeEntityExtensions
Extensions on SnowflakeEntitys.
TextEmojiExtensions
Extensions on TextEmoji.
ThreadExtensions
Extensions on Threads.
UserManagerExtensions
Extensions on UserManagers.

Properties

channelMentionRegex RegExp
A pattern that matches channel mentions in a message.
final
everyoneMentionRegex RegExp
A pattern that matches @everyone and @here mentions in a message.
final
guildEmojiRegex RegExp
A pattern that matches guild emojis in a message.
final
guildJoins GuildJoins
A global instance of the GuildJoins plugin.
final
pagination Pagination
A global instance of the Pagination plugin with default options.
final
roleMentionRegex RegExp
A pattern that matches role mentions in a message.
final
userMentionRegex RegExp
A pattern that matches user mentions in a message.
final

Functions

bold(String content) String
Wraps the content inside **.
channelMention(Snowflake id) String
Formats a channel ID into a channel mention.
codeBlock(String code, [String language = '']) String
Wraps the code in a code block with the specified language, if any.
computePermissions(GuildChannel channel, Member member) Future<Permissions>
Compute the permissions for member in a given channel.
formatDate(DateTime date, [TimestampStyle style = TimestampStyle.none]) String
Formats the date into a date string timestamp.
getEmojiDefinitions() Future<List<EmojiDefinition>>
List all the emoji definitions currently available.
hideEmbed(String url) String
Wraps the url inside <>, used to remove its embed.
Format the content and the URL into a hyperlink (aka Markdown link), and optionally, add a title that will be displayed on hover.
inlineCode(String content) String
Wraps the content inside backticks.
italic(String content) String
Wraps the content inside *.
quote(String content) String
Quotes the content.
quoteBlock(String content) String
Quotes the content in a quote block.
roleMention(Snowflake id) String
Formats a role ID into a role mention.
sanitizeContent(String content, {required PartialTextChannel channel, SanitizerAction action = SanitizerAction.sanitize, Map<SanitizerTarget, SanitizerAction>? actionOverrides}) Future<String>
Find SanitizerTargets in content and sanitize them according to action.
spoiler(String content) String
Wraps the content inside ||.
strikethrough(String content) String
Wraps the content inside ~~.
underline(String content) String
Wraps the content inside __.
userMention(Snowflake id) String
Formats a user ID into a user mention.

Enums

SanitizerAction
An action sanitizeContent can take on a target.
SanitizerTarget
A type of target sanitizeContent can operate on.
StreamOrder
Controls the order in which entities from paginated endpoints are streamed.
TimestampStyle