Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AccessContext - Interface in dev.sympho.bot_utils.access
-
Context around the access of a program function by a user.
- AccessManager - Interface in dev.sympho.bot_utils.access
-
A manager that provides access validators for different execution contexts.
- AccessValidator - Interface in dev.sympho.bot_utils.access
-
Validator that determines whether a caller has certain access rights in the context of an invocation.
- addDnsRetry() - Static method in class dev.sympho.bot_utils.HttpClientUtils
-
Creates a function that adds DNS retry capabilities to a connection mono, using the
default retry policy. - addDnsRetry(HttpClient) - Static method in class dev.sympho.bot_utils.HttpClientUtils
-
Adds DNS retry capabilities to an HTTP client, using the
default retry policy. - addDnsRetry(HttpClient, Retry) - Static method in class dev.sympho.bot_utils.HttpClientUtils
-
Adds DNS retry capabilities to an HTTP client.
- addDnsRetry(Retry) - Static method in class dev.sympho.bot_utils.HttpClientUtils
-
Creates a function that adds DNS retry capabilities to a connection mono.
- ADMINS - Static variable in class dev.sympho.bot_utils.access.Groups
-
The group of server admins (matches users with the
administratorpermission). - all(Group...) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of all of the given groups.
- all(GuildGroup...) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of all of the given groups.
- all(Iterable<Group>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of all of the given groups.
- all(Stream<Group>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of all of the given groups.
- all(Flux<Group>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of all of the given groups.
- allGuild(GuildGroup...) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of all of the given groups.
- allGuild(Iterable<GuildGroup>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of all of the given groups.
- allGuild(Stream<GuildGroup>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of all of the given groups.
- allGuild(Flux<GuildGroup>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of all of the given groups.
- alwaysAllow() - Static method in interface dev.sympho.bot_utils.access.AccessManager
-
Creates a manager for which all validators always allow access.
- alwaysDeny() - Static method in interface dev.sympho.bot_utils.access.AccessManager
-
Creates a manager for which all validators always deny access.
- any(Group...) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of any of the given groups.
- any(GuildGroup...) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of any of the given groups.
- any(Iterable<Group>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of any of the given groups.
- any(Stream<Group>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of any of the given groups.
- any(Flux<Group>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of any of the given groups.
- anyGuild(GuildGroup...) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of any of the given groups.
- anyGuild(Iterable<GuildGroup>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of any of the given groups.
- anyGuild(Stream<GuildGroup>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of any of the given groups.
- anyGuild(Flux<GuildGroup>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Composes multiple groups into a single group where a user is only a member if they are a member of any of the given groups.
- apply(C, String) - Method in interface dev.sympho.bot_utils.component.ComponentManager.HandlerFunction
-
Handles an interaction event.
- args() - Method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Returns the value of the
argsrecord component. - asGuild(Snowflake) - Method in interface dev.sympho.bot_utils.access.AccessContext
-
Creates a copy of this context with the guild replaced by the given guild.
- asUser(User) - Method in interface dev.sympho.bot_utils.access.AccessContext
-
Creates a copy of this context with the user replaced by the given user.
- asUser(User) - Method in interface dev.sympho.bot_utils.access.ChannelAccessContext
-
Creates a copy of this context with the user replaced by the given user.
- attachData(String, byte[], boolean) - Static method in class dev.sympho.bot_utils.DiscordUtils
-
Prepares data to be attached to a message as a file.
- attachImage(String, BufferedImage, boolean) - Static method in class dev.sympho.bot_utils.DiscordUtils
-
Prepares an image to be attached to a message.
- ATTACHMENT - Enum constant in enum class dev.sympho.bot_utils.HttpClientUtils.EndpointType
-
Attachment files.
- AttachmentException(String, Throwable) - Constructor for exception dev.sympho.bot_utils.DiscordUtils.AttachmentException
-
Creates a new instance.
B
- basic() - Static method in interface dev.sympho.bot_utils.access.AccessManager
-
Creates a manager that issues validators that perform simple group memebership checks (that is, a user has equivalent access to a group if and only if they belong to that group).
- belongs(AccessContext) - Method in interface dev.sympho.bot_utils.access.GuildGroup
-
Determines whether the user in the given context belongs to this group.
- belongs(ChannelAccessContext) - Method in interface dev.sympho.bot_utils.access.Group
-
Determines whether the user in the given context belongs to this group.
- belongs(ChannelAccessContext) - Method in interface dev.sympho.bot_utils.access.GuildGroup
- belongs(User, AccessContext) - Method in interface dev.sympho.bot_utils.access.GuildGroup
-
Determines whether the given user belongs to this group in the context of the given guild and channel.
- belongs(User, ChannelAccessContext) - Method in interface dev.sympho.bot_utils.access.Group
-
Determines whether the given user belongs to this group in the context of the given guild and channel.
- BOOSTER - Static variable in class dev.sympho.bot_utils.access.Groups
-
The group that matches a booster in the invoking server.
- BOT_OWNER - Static variable in class dev.sympho.bot_utils.access.Groups
-
The group that only matches the bot owner.
- BUTTON_ID_DISPLAY - Static variable in class dev.sympho.bot_utils.PaginationManager
-
The ID for the counter display button.
- BUTTON_ID_UPDATE - Static variable in class dev.sympho.bot_utils.PaginationManager
-
The base ID for an update button.
- ButtonManager - Class in dev.sympho.bot_utils.component
-
Centralized manager for button interaction handling.
- ButtonManager(GatewayDiscordClient, AccessManager) - Constructor for class dev.sympho.bot_utils.component.ButtonManager
-
Creates a new manager that receives interactions from the given client.
- ButtonManager.ButtonContext - Class in dev.sympho.bot_utils.component
-
The execution context of a button being pressed.
- ButtonManager.Handler - Record Class in dev.sympho.bot_utils.component
-
Specification for the handling of a button.
- ButtonManager.HandlerEntry - Record Class in dev.sympho.bot_utils.component
-
Specification for a handler to be registered.
- ButtonManager.HandlerFunction - Interface in dev.sympho.bot_utils.component
-
A function used to handle a button press event.
C
- ChannelAccessContext - Interface in dev.sympho.bot_utils.access
-
Access context that is specific to a channel.
- ComponentContext(E, AccessManager) - Constructor for class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
-
Creates a new instance.
- ComponentManager<E extends @NonNull ComponentInteractionEvent,
C extends @NonNull ComponentManager.ComponentContext<E>, HF extends @NonNull ComponentManager.HandlerFunction<C>, H extends @NonNull ComponentManager.Handler<H, HF>, HE extends @NonNull ComponentManager.HandlerEntry<H>> - Class in dev.sympho.bot_utils.component -
Centralized manager for component interaction handling.
- ComponentManager(GatewayDiscordClient, AccessManager) - Constructor for class dev.sympho.bot_utils.component.ComponentManager
-
Creates a new manager that receives interactions from the given client.
- ComponentManager.ComponentContext<E extends @NonNull ComponentInteractionEvent> - Class in dev.sympho.bot_utils.component
-
The execution context of a component being interacted with.
- ComponentManager.Handler<SELF,
HF extends @NonNull ComponentManager.HandlerFunction<?>> - Interface in dev.sympho.bot_utils.component -
Specification for the handling of an interaction.
- ComponentManager.HandlerEntry<H extends @NonNull ComponentManager.Handler<H,
?>> - Interface in dev.sympho.bot_utils.component -
Specification for a handler to be registered.
- ComponentManager.HandlerFunction<C extends @NonNull ComponentManager.ComponentContext<?>> - Interface in dev.sympho.bot_utils.component
-
A function used to handle an interaction event.
- components() - Method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Returns the value of the
componentsrecord component. - compose(UnaryOperator<ButtonManager.HandlerFunction>) - Method in record class dev.sympho.bot_utils.component.ButtonManager.Handler
- compose(UnaryOperator<ModalManager.HandlerFunction>) - Method in record class dev.sympho.bot_utils.component.ModalManager.Handler
- compose(UnaryOperator<HF>) - Method in interface dev.sympho.bot_utils.component.ComponentManager.Handler
-
Composes this handler by transforming its handler function.
- configureClient() - Method in enum class dev.sympho.bot_utils.HttpClientUtils.EndpointType
-
Creates and configures an HTTP client to use with this endpoint type, using the
default retry policy. - configureClient(HttpClient) - Method in enum class dev.sympho.bot_utils.HttpClientUtils.EndpointType
-
Configures an HTTP client to use with this endpoint type, using the
default retry policy. - configureClient(HttpClient, Retry) - Method in enum class dev.sympho.bot_utils.HttpClientUtils.EndpointType
-
Configures an HTTP client to use with this endpoint type.
- configureClient(Retry) - Method in enum class dev.sympho.bot_utils.HttpClientUtils.EndpointType
-
Creates and configures an HTTP client to use with this endpoint type.
- content() - Method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Returns the value of the
contentrecord component.
D
- DEFAULT_DNS_RETRY_POLICY - Static variable in class dev.sympho.bot_utils.HttpClientUtils
-
The default DNS retry policy.
- dev.sympho.bot_utils - package dev.sympho.bot_utils
-
Root project package.
- dev.sympho.bot_utils.access - package dev.sympho.bot_utils.access
-
API for managing access to features.
- dev.sympho.bot_utils.component - package dev.sympho.bot_utils.component
-
Utilities for using Discord components.
- DiscordUtils - Class in dev.sympho.bot_utils
-
Provides assorted utilities for interacting with Discord.
- DiscordUtils.AttachmentException - Exception in dev.sympho.bot_utils
-
Exception that represents an error encountered while creating an attachment.
E
- enableMetrics(HttpClient, HttpClientUtils.EndpointType) - Static method in class dev.sympho.bot_utils.HttpClientUtils
-
Enables metrics on an HTTP client.
- equals(Object) - Method in record class dev.sympho.bot_utils.component.ButtonManager.Handler
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.sympho.bot_utils.component.ButtonManager.HandlerEntry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.sympho.bot_utils.component.ModalManager.Handler
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.sympho.bot_utils.component.ModalManager.HandlerEntry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Indicates whether some other object is "equal to" this one.
- EVERYONE - Static variable in class dev.sympho.bot_utils.access.Groups
-
The group of all Discord users (matches everyone).
G
- generateFirst(String) - Method in class dev.sympho.bot_utils.PaginationManager.Paginator
-
Generates the first page.
- generatePage(int, String) - Method in interface dev.sympho.bot_utils.PaginationManager.PageGenerator
-
Generates a page.
- getChannel() - Method in interface dev.sympho.bot_utils.access.ChannelAccessContext
-
Retrieves the channel.
- getChannel() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
- getChannelId() - Method in interface dev.sympho.bot_utils.access.ChannelAccessContext
-
Retrieves the ID of the channel.
- getChannelId() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
- getClient() - Method in interface dev.sympho.bot_utils.access.AccessContext
-
Retrieves the backing client.
- getClient() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
- getEvent() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
-
Retrieves the triggering event.
- getEventType() - Method in class dev.sympho.bot_utils.component.ButtonManager
- getEventType() - Method in class dev.sympho.bot_utils.component.ComponentManager
-
Retrieves the interaction event type.
- getEventType() - Method in class dev.sympho.bot_utils.component.ModalManager
- getField(String) - Method in class dev.sympho.bot_utils.component.ModalManager.ModalContext
-
Retrieves the input field with the given custom ID.
- getFields() - Method in class dev.sympho.bot_utils.component.ModalManager.ModalContext
-
Retrieves the input fields in this context.
- getGuild() - Method in interface dev.sympho.bot_utils.access.AccessContext
-
Retrieves the guild, if there is one.
- getGuild() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
- getGuildId() - Method in interface dev.sympho.bot_utils.access.AccessContext
-
Retrieves the ID of the guild, if there is one.
- getGuildId() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
- getInteraction() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
-
Retrieves the interaction associated with the event.
- getMember() - Method in interface dev.sympho.bot_utils.access.AccessContext
-
Retrieves the user as a guild member.
- getMember() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
- getMember(Snowflake) - Method in interface dev.sympho.bot_utils.access.AccessContext
-
Retrieves the user as a guild member of the given guild.
- getMember(Snowflake) - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
- getMessage() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
-
Retrieves the message that the component is attached to.
- getMessageId() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
-
Retrieves the ID of the message that the component is attached to.
- getUser() - Method in interface dev.sympho.bot_utils.access.AccessContext
-
Retrieves the user.
- getUser() - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
- group() - Method in record class dev.sympho.bot_utils.component.ButtonManager.Handler
-
Returns the value of the
grouprecord component. - Group - Interface in dev.sympho.bot_utils.access
-
Specifies a group that users may belong to.
- Groups - Class in dev.sympho.bot_utils.access
-
Default group types and composition operations.
- GuildGroup - Interface in dev.sympho.bot_utils.access
-
A group whose membership is defined at the guild level or higher (i.e.
H
- handler() - Method in record class dev.sympho.bot_utils.component.ButtonManager.Handler
-
Returns the value of the
handlerrecord component. - handler() - Method in record class dev.sympho.bot_utils.component.ButtonManager.HandlerEntry
-
Returns the value of the
handlerrecord component. - handler() - Method in interface dev.sympho.bot_utils.component.ComponentManager.Handler
-
The handler function.
- handler() - Method in interface dev.sympho.bot_utils.component.ComponentManager.HandlerEntry
-
The handler to use.
- handler() - Method in record class dev.sympho.bot_utils.component.ModalManager.Handler
-
Returns the value of the
handlerrecord component. - handler() - Method in record class dev.sympho.bot_utils.component.ModalManager.HandlerEntry
-
Returns the value of the
handlerrecord component. - Handler(ButtonManager.HandlerFunction, Group) - Constructor for record class dev.sympho.bot_utils.component.ButtonManager.Handler
-
Creates an instance of a
Handlerrecord class. - Handler(ModalManager.HandlerFunction) - Constructor for record class dev.sympho.bot_utils.component.ModalManager.Handler
-
Creates an instance of a
Handlerrecord class. - HandlerEntry(String, ButtonManager.Handler, boolean) - Constructor for record class dev.sympho.bot_utils.component.ButtonManager.HandlerEntry
-
Creates an instance of a
HandlerEntryrecord class. - HandlerEntry(String, ModalManager.Handler) - Constructor for record class dev.sympho.bot_utils.component.ModalManager.HandlerEntry
-
Creates an instance of a
HandlerEntryrecord class. - hasAccess(Group) - Method in interface dev.sympho.bot_utils.access.AccessValidator
-
Determines whether the invoking user in the current execution context has access equivalent to the given group.
- hasAccess(Group) - Method in class dev.sympho.bot_utils.component.ComponentManager.ComponentContext
- hasChannelPermissions(PermissionSet) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have the given permissions in the channel.
- hasChannelPermissions(Supplier<PermissionSet>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have the given permissions in the channel.
- hasChannelPermissions(Mono<PermissionSet>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have the given permissions in the channel.
- hasGuildPermissions(PermissionSet) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have the given permissions in the guild.
- hasGuildPermissions(Supplier<PermissionSet>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have the given permissions in the guild.
- hasGuildPermissions(Mono<PermissionSet>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have the given permissions in the guild.
- hashCode() - Method in record class dev.sympho.bot_utils.component.ButtonManager.Handler
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.sympho.bot_utils.component.ButtonManager.HandlerEntry
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.sympho.bot_utils.component.ModalManager.Handler
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.sympho.bot_utils.component.ModalManager.HandlerEntry
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Returns a hash code value for this object.
- hasRole(Snowflake) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have the given role.
- hasRole(Supplier<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have the given role.
- hasRole(Mono<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have the given role.
- hasRolesAll(Snowflake...) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have all of the given roles.
- hasRolesAll(Collection<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have all of the given roles.
- hasRolesAll(Supplier<? extends Collection<Snowflake>>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have all of the given roles.
- hasRolesAll(Flux<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have all of the given roles.
- hasRolesAll(Mono<? extends Collection<Snowflake>>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have all of the given roles.
- hasRolesAny(Snowflake...) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have any of the given roles.
- hasRolesAny(Collection<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have any of the given roles.
- hasRolesAny(Supplier<? extends Collection<Snowflake>>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have any of the given roles.
- hasRolesAny(Flux<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have any of the given roles.
- hasRolesAny(Mono<? extends Collection<Snowflake>>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group defined as all users that have any of the given roles.
- HttpClientUtils - Class in dev.sympho.bot_utils
-
Utilities for using HTTP clients.
- HttpClientUtils.EndpointType - Enum Class in dev.sympho.bot_utils
-
Endpoint types used to interact with Discord.
I
- id() - Method in record class dev.sympho.bot_utils.component.ButtonManager.HandlerEntry
-
Returns the value of the
idrecord component. - id() - Method in interface dev.sympho.bot_utils.component.ComponentManager.HandlerEntry
-
The component ID.
- id() - Method in record class dev.sympho.bot_utils.component.ModalManager.HandlerEntry
-
Returns the value of the
idrecord component. - index() - Method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Returns the value of the
indexrecord component. - inWhitelist(Snowflake...) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group composed of a set of users.
- inWhitelist(Collection<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group composed of a set of users.
- inWhitelist(Supplier<? extends Collection<Snowflake>>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group composed of a set of users.
- inWhitelist(Flux<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group composed of a set of users.
- inWhitelist(Mono<? extends Collection<Snowflake>>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group composed of a set of users.
- isPrivate() - Method in interface dev.sympho.bot_utils.access.AccessContext
-
Determines if this context is a private channel.
- isUser(Snowflake) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group composed of a single user.
- isUser(Supplier<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group composed of a single user.
- isUser(Mono<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Creates a group composed of a single user.
L
- logger - Variable in class dev.sympho.bot_utils.component.ComponentManager
-
Logger.
M
- makeContext(ButtonInteractionEvent, AccessManager) - Method in class dev.sympho.bot_utils.component.ButtonManager
- makeContext(ModalSubmitInteractionEvent, AccessManager) - Method in class dev.sympho.bot_utils.component.ModalManager
- makeContext(E, AccessManager) - Method in class dev.sympho.bot_utils.component.ComponentManager
-
Creates the interaction context.
- makeId(String, String) - Static method in class dev.sympho.bot_utils.component.ButtonManager
-
Creates a custom ID for a button with arguments in a format that is compatible with this manager.
- makeId(String, String) - Static method in class dev.sympho.bot_utils.component.ComponentManager
-
Creates a custom ID for a component with arguments in a format that is compatible with a manager.
- makeId(String, String) - Static method in class dev.sympho.bot_utils.component.ModalManager
-
Creates a custom ID for a modal with arguments in a format that is compatible with this manager.
- MAX_ROWS - Static variable in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Maximum number of component rows.
- mentionChannel(Snowflake) - Static method in class dev.sympho.bot_utils.DiscordUtils
-
Constructs a mention to a channel.
- mentionRole(Snowflake) - Static method in class dev.sympho.bot_utils.DiscordUtils
-
Constructs a mention to a role.
- mentionUser(Snowflake) - Static method in class dev.sympho.bot_utils.DiscordUtils
-
Constructs a mention to a user.
- ModalManager - Class in dev.sympho.bot_utils.component
-
Centralized manager for modal submission handling.
- ModalManager(GatewayDiscordClient, AccessManager) - Constructor for class dev.sympho.bot_utils.component.ModalManager
-
Creates a new manager that receives interactions from the given client.
- ModalManager.Handler - Record Class in dev.sympho.bot_utils.component
-
Specification for the handling of a modal submission.
- ModalManager.HandlerEntry - Record Class in dev.sympho.bot_utils.component
-
Specification for a handler to be registered.
- ModalManager.HandlerFunction - Interface in dev.sympho.bot_utils.component
-
A function used to handle a modal submit event.
- ModalManager.ModalContext - Class in dev.sympho.bot_utils.component
-
The execution context of a modal being submitted.
- mutex() - Method in record class dev.sympho.bot_utils.component.ButtonManager.HandlerEntry
-
Returns the value of the
mutexrecord component. - mutex(ButtonManager.HandlerFunction) - Method in class dev.sympho.bot_utils.component.ButtonManager
-
Converts a handler into a mutually-exclusive handler, where concurrent interactions to buttons in the same message (not necessarily the same button, but any button in the message whose handler is also a mutex in this manager) will only allow one execution (namely the first) to proceeed while the others fail, until the executing handler finishes.
N
- name() - Method in interface dev.sympho.bot_utils.access.NamedGroup
-
Retrieves the name of the group.
- named(Group, String) - Static method in class dev.sympho.bot_utils.access.Groups
-
Adds a name to an existing group.
- named(GuildGroup, String) - Static method in class dev.sympho.bot_utils.access.Groups
-
Adds a name to an existing group.
- NamedGroup - Interface in dev.sympho.bot_utils.access
-
A group that also has a name.
- NamedGuildGroup - Interface in dev.sympho.bot_utils.access
-
A guild group that also has a name.
- NOBODY - Static variable in class dev.sympho.bot_utils.access.Groups
-
The empty group (matches nobody).
O
- of(ButtonManager.HandlerFunction) - Static method in record class dev.sympho.bot_utils.component.ButtonManager.Handler
-
Creates a handler that uses the given function and requires no groups.
- of(ButtonManager.HandlerFunction, Group) - Static method in record class dev.sympho.bot_utils.component.ButtonManager.Handler
-
Creates a handler that uses the given function and requires the given group.
- of(ModalManager.HandlerFunction) - Static method in record class dev.sympho.bot_utils.component.ModalManager.Handler
-
Creates a handler that uses the given function..
- of(Member) - Static method in interface dev.sympho.bot_utils.access.AccessContext
-
Creates an access context for the given member, in the guild that the member is from.
- of(User, Snowflake) - Static method in interface dev.sympho.bot_utils.access.AccessContext
-
Creates an access context for the given user in the given guild.
- of(String, int, int, EmbedCreateSpec) - Static method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Creates a new instance.
- of(String, int, int, EmbedCreateSpec, List<LayoutComponent>) - Static method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Creates a new instance.
- of(String, ButtonManager.HandlerFunction, boolean) - Static method in record class dev.sympho.bot_utils.component.ButtonManager.HandlerEntry
-
Creates a handler with the given ID that uses the given function and requires no groups.
- of(String, ButtonManager.HandlerFunction, boolean, Group) - Static method in record class dev.sympho.bot_utils.component.ButtonManager.HandlerEntry
-
Creates a handler with the given ID that uses the given function and requires the given group.
- of(String, ModalManager.HandlerFunction) - Static method in record class dev.sympho.bot_utils.component.ModalManager.HandlerEntry
-
Creates a handler with the given ID that uses the given function.
- overridable(Group) - Static method in interface dev.sympho.bot_utils.access.AccessManager
-
Creates a manager that issues validators that generally perform group membership checks, but also allows a given group to override any permission in the system (that is, users that are members of the given group have equivalent permissions to any other group).
P
- pageCount() - Method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Returns the value of the
pageCountrecord component. - PageData(String, int, int, EmbedCreateSpec, List<LayoutComponent>) - Constructor for record class dev.sympho.bot_utils.PaginationManager.PageData
-
Creates a new instance.
- pageUpdateHandler() - Method in class dev.sympho.bot_utils.PaginationManager
-
Configures the handler for page update buttons.
- PaginationManager - Class in dev.sympho.bot_utils
-
Manager for displaying paginated data.
- PaginationManager() - Constructor for class dev.sympho.bot_utils.PaginationManager
-
Creates a new instance.
- PaginationManager.PageData - Record Class in dev.sympho.bot_utils
-
The data of a page to be displayed.
- PaginationManager.PageGenerator - Interface in dev.sympho.bot_utils
-
A function that generates the contents of a page.
- PaginationManager.Paginator - Class in dev.sympho.bot_utils
-
Entity responsible for generating content pages of a certain type.
R
- register(ButtonManager.HandlerEntry) - Method in class dev.sympho.bot_utils.component.ButtonManager
- register(HE) - Method in class dev.sympho.bot_utils.component.ComponentManager
-
Registers an interaction handler.
- register(String, Group, PaginationManager.PageGenerator) - Method in class dev.sympho.bot_utils.PaginationManager
-
Registers a paginator.
- register(String, PaginationManager.PageGenerator) - Method in class dev.sympho.bot_utils.PaginationManager
-
Registers a paginator with no access restrictions.
- register(String, H) - Method in class dev.sympho.bot_utils.component.ComponentManager
-
Registers a handler.
- registerAll(Collection<HE>) - Method in class dev.sympho.bot_utils.component.ComponentManager
-
Registers a group of handlers.
- remote(GuildGroup, Snowflake) - Static method in class dev.sympho.bot_utils.access.Groups
-
Decorates a group so that membership is always checked in relation to the given guild, rather than the guild where the command was executed in.
- remote(GuildGroup, Supplier<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Decorates a group so that membership is always checked in relation to the given guild, rather than the guild where the command was executed in.
- remote(GuildGroup, Mono<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Decorates a group so that membership is always checked in relation to the given guild, rather than the guild where the command was executed in.
- remote(NamedGuildGroup, Snowflake) - Static method in class dev.sympho.bot_utils.access.Groups
-
Decorates a group so that membership is always checked in relation to the given guild, rather than the guild where the command was executed in.
- remote(NamedGuildGroup, Supplier<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Decorates a group so that membership is always checked in relation to the given guild, rather than the guild where the command was executed in.
- remote(NamedGuildGroup, Mono<Snowflake>) - Static method in class dev.sympho.bot_utils.access.Groups
-
Decorates a group so that membership is always checked in relation to the given guild, rather than the guild where the command was executed in.
- REST - Enum constant in enum class dev.sympho.bot_utils.HttpClientUtils.EndpointType
-
The REST API.
S
- SERVER_OWNER - Static variable in class dev.sympho.bot_utils.access.Groups
-
The group that only matches the server owner.
- start() - Method in class dev.sympho.bot_utils.component.ComponentManager
-
Starts handling interactions.
- stop() - Method in class dev.sympho.bot_utils.component.ComponentManager
-
Stops handling interactions.
T
- toPossible(Optional<T>) - Static method in class dev.sympho.bot_utils.DiscordUtils
-
Converts an
Optionalinto aPossible. - toSpec(Embed) - Static method in class dev.sympho.bot_utils.DiscordUtils
-
Creates an embed spec from an embed.
- toString() - Method in record class dev.sympho.bot_utils.component.ButtonManager.Handler
-
Returns a string representation of this record class.
- toString() - Method in record class dev.sympho.bot_utils.component.ButtonManager.HandlerEntry
-
Returns a string representation of this record class.
- toString() - Method in record class dev.sympho.bot_utils.component.ModalManager.Handler
-
Returns a string representation of this record class.
- toString() - Method in record class dev.sympho.bot_utils.component.ModalManager.HandlerEntry
-
Returns a string representation of this record class.
- toString() - Method in record class dev.sympho.bot_utils.PaginationManager.PageData
-
Returns a string representation of this record class.
U
- unregister(String) - Method in class dev.sympho.bot_utils.component.ComponentManager
-
Unregisters an interaction handler, if it exists.
- uriTagFormatter() - Method in enum class dev.sympho.bot_utils.HttpClientUtils.EndpointType
-
Retrieves the URI formatter to use for metric tags.
V
- validate(Group) - Method in interface dev.sympho.bot_utils.access.AccessValidator
-
Determines whether the invoking user in the current execution context has access equivalent to the given group.
- validateInteraction(C, H) - Method in class dev.sympho.bot_utils.component.ComponentManager
-
Validates that the interaction is allowed.
- validateInteraction(ButtonManager.ButtonContext, ButtonManager.Handler) - Method in class dev.sympho.bot_utils.component.ButtonManager
- validateInteraction(ModalManager.ModalContext, ModalManager.Handler) - Method in class dev.sympho.bot_utils.component.ModalManager
- validator(ChannelAccessContext) - Method in interface dev.sympho.bot_utils.access.AccessManager
-
Creates an access validator under the given context.
- valueOf(String) - Static method in enum class dev.sympho.bot_utils.HttpClientUtils.EndpointType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.sympho.bot_utils.HttpClientUtils.EndpointType
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form