Package dev.sympho.modular_commands.api.permission

Class Groups

java.lang.Object
dev.sympho.modular_commands.api.permission.Groups
public final class Groups extends Object
Default group types and composition operations.
Since:
1.0
Version:
1.0

  • Field Details

    • EVERYONE

      public static final NamedGuildGroup EVERYONE
      The group of all Discord users (matches everyone).

    • NOBODY

      public static final NamedGuildGroup NOBODY
      The empty group (matches nobody).

    • ADMINS

      public static final NamedGuildGroup ADMINS
      The group of server admins (matches users with the administrator permission).

    • SERVER_OWNER

      public static final NamedGuildGroup SERVER_OWNER
      The group that only matches the server owner.

    • BOT_OWNER

      public static final NamedGuildGroup BOT_OWNER
      The group that only matches the bot owner.

    • BOOSTER

      public static final NamedGuildGroup BOOSTER
      The group that matches a booster in the invoking server.

      Note that, unlike groups like ADMINS or hasGuildPermissions(PermissionSet), this group will never match on a private channel, as usually the goal is paywalling a feature rather than limiting permissions.

  • Method Details

    • named

      public static NamedGroup named(Group group, String name)
      Adds a name to an existing group.
      Parameters:
      group - The group.
      name - The name.
      Returns:
      The given group with the name set to the given name.

    • named

      public static NamedGuildGroup named(GuildGroup group, String name)
      Adds a name to an existing group.
      Parameters:
      group - The group.
      name - The name.
      Returns:
      The given group with the name set to the given name.

    • remote

      public static GuildGroup remote(GuildGroup group, Mono<Snowflake> guild)
      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.

      In other words, this overrides the guild parameter provided to the Group.belongs(ChannelAccessContext) method to the given guild, before delegating to the given group.

      This allows for permission checking on commands that always operate on some remote guild, and thus should be checked in relation to that guild.

      Parameters:
      group - The group.
      guild - The guild where group membership should be checked for. The issued value may change over time, but may not be empty.
      Returns:
      The decorated group.

    • remote

      public static NamedGuildGroup remote(NamedGuildGroup group, Mono<Snowflake> guild)
      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.

      In other words, this overrides the guild parameter provided to the Group.belongs(ChannelAccessContext) method to the given guild, before delegating to the given group.

      This allows for permission checking on commands that always operate on some remote guild, and thus should be checked in relation to that guild.

      The name of the group is passed through.

      Parameters:
      group - The group.
      guild - The guild where group membership should be checked for. The issued value may change over time, but may not be empty.
      Returns:
      The decorated group.
      API Note:
      If the name of the group will be overriden, an explicit cast to the non-named variant may be used to avoid an unecessary wrapping layer: named(remote((GuildGroup) group, guild), "some name")

    • remote

      public static GuildGroup remote(GuildGroup group, Supplier<Snowflake> guild)
      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.

      This allows for permission checking on commands that always operate on some remote guild, and thus should be checked in relation to that guild.

      Parameters:
      group - The group.
      guild - The guild where group membership should be checked for. The issued value may change over time.
      Returns:
      The decorated group.

    • remote

      public static NamedGuildGroup remote(NamedGuildGroup group, Supplier<Snowflake> guild)
      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.

      This allows for permission checking on commands that always operate on some remote guild, and thus should be checked in relation to that guild.

      The name of the group is passed through.

      Parameters:
      group - The group.
      guild - The guild where group membership should be checked for. The issued value may change over time.
      Returns:
      The decorated group.
      API Note:
      If the name of the group will be overriden, an explicit cast to the non-named variant may be used to avoid an unecessary wrapping layer: named(remote((GuildGroup) group, guild), "some name")

    • remote

      public static GuildGroup remote(GuildGroup group, Snowflake guild)
      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.

      This allows for permission checking on commands that always operate on some remote guild, and thus should be checked in relation to that guild.

      Parameters:
      group - The group.
      guild - The guild where group membership should be checked for.
      Returns:
      The decorated group.

    • remote

      public static NamedGuildGroup remote(NamedGuildGroup group, Snowflake guild)
      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.

      This allows for permission checking on commands that always operate on some remote guild, and thus should be checked in relation to that guild.

      The name of the group is passed through.

      Parameters:
      group - The group.
      guild - The guild where group membership should be checked for.
      Returns:
      The decorated group.
      API Note:
      If the name of the group will be overriden, an explicit cast to the non-named variant may be used to avoid an unecessary wrapping layer: named(remote((Group) group, guild), "some name")

    • any

      public static Group any(Flux<Group> 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.
      Parameters:
      groups - The groups to compose. The issued values may change over time (between subscriptions).
      Returns:
      The composed group.

    • any

      public static Group any(Stream<Group> 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • any

      public static Group any(Iterable<Group> 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • any

      public static Group any(Group... 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • any

      public static GuildGroup any(GuildGroup... 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • anyGuild

      public static GuildGroup anyGuild(Flux<GuildGroup> 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.
      Parameters:
      groups - The groups to compose. The issued values may change over time (between subscriptions).
      Returns:
      The composed group.

    • anyGuild

      public static GuildGroup anyGuild(Stream<GuildGroup> 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • anyGuild

      public static GuildGroup anyGuild(Iterable<GuildGroup> 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • anyGuild

      public static GuildGroup anyGuild(GuildGroup... 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • all

      public static Group all(Flux<Group> 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.
      Parameters:
      groups - The groups to compose. The issued values may change over time (between subscriptions).
      Returns:
      The composed group.

    • all

      public static Group all(Stream<Group> 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • all

      public static Group all(Iterable<Group> 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • all

      public static Group all(Group... 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • all

      public static GuildGroup all(GuildGroup... 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • allGuild

      public static GuildGroup allGuild(Flux<GuildGroup> 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.
      Parameters:
      groups - The groups to compose. The issued values may change over time (between subscriptions).
      Returns:
      The composed group.

    • allGuild

      public static GuildGroup allGuild(Stream<GuildGroup> 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • allGuild

      public static GuildGroup allGuild(Iterable<GuildGroup> 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • allGuild

      public static GuildGroup allGuild(GuildGroup... 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.
      Parameters:
      groups - The groups to compose.
      Returns:
      The composed group.

    • isUser

      public static GuildGroup isUser(Mono<Snowflake> user)
      Creates a group composed of a single user.
      Parameters:
      user - The user. The issued value may change over time.
      Returns:
      The group.

    • isUser

      public static GuildGroup isUser(Supplier<Snowflake> user)
      Creates a group composed of a single user.
      Parameters:
      user - The user. The issued value may change over time.
      Returns:
      The group.

    • isUser

      public static GuildGroup isUser(Snowflake user)
      Creates a group composed of a single user.
      Parameters:
      user - The user.
      Returns:
      The group.

    • inWhitelist

      public static GuildGroup inWhitelist(Flux<Snowflake> users)
      Creates a group composed of a set of users.
      Parameters:
      users - The users that belong to the group. The issued values may vary over time (between subscriptions).
      Returns:
      The group.

    • inWhitelist

      public static GuildGroup inWhitelist(Mono<? extends Collection<Snowflake>> users)
      Creates a group composed of a set of users.
      Parameters:
      users - The users that belong to the group. The issued values may vary over time (between subscriptions).
      Returns:
      The group.

    • inWhitelist

      public static GuildGroup inWhitelist(Supplier<? extends Collection<Snowflake>> users)
      Creates a group composed of a set of users.
      Parameters:
      users - The users that belong to the group. The issued values may vary over time (between requests).
      Returns:
      The group.

    • inWhitelist

      public static GuildGroup inWhitelist(Collection<Snowflake> users)
      Creates a group composed of a set of users.
      Parameters:
      users - The users that belong to the group.
      Returns:
      The group.

    • inWhitelist

      public static GuildGroup inWhitelist(Snowflake... users)
      Creates a group composed of a set of users.
      Parameters:
      users - The users that belong to the group.
      Returns:
      The group.

    • hasRole

      public static GuildGroup hasRole(Mono<Snowflake> role)
      Creates a group defined as all users that have the given role.
      Parameters:
      role - The role. The issued value may vary over time.
      Returns:
      The group.

    • hasRole

      public static GuildGroup hasRole(Supplier<Snowflake> role)
      Creates a group defined as all users that have the given role.
      Parameters:
      role - The role. The issued value may vary over time.
      Returns:
      The group.

    • hasRole

      public static GuildGroup hasRole(Snowflake role)
      Creates a group defined as all users that have the given role.
      Parameters:
      role - The role.
      Returns:
      The group.

    • hasRolesAny

      public static GuildGroup hasRolesAny(Mono<? extends Collection<Snowflake>> roles)
      Creates a group defined as all users that have any of the given roles.
      Parameters:
      roles - The roles. The issued values may vary over time (between subscriptions).
      Returns:
      The group.

    • hasRolesAny

      public static GuildGroup hasRolesAny(Flux<Snowflake> roles)
      Creates a group defined as all users that have any of the given roles.
      Parameters:
      roles - The roles. The issued values may vary over time (between subscriptions).
      Returns:
      The group.

    • hasRolesAny

      public static GuildGroup hasRolesAny(Supplier<? extends Collection<Snowflake>> roles)
      Creates a group defined as all users that have any of the given roles.
      Parameters:
      roles - The roles. The issued values may vary over time.
      Returns:
      The group.

    • hasRolesAny

      public static GuildGroup hasRolesAny(Collection<Snowflake> roles)
      Creates a group defined as all users that have any of the given roles.
      Parameters:
      roles - The roles.
      Returns:
      The group.

    • hasRolesAny

      public static GuildGroup hasRolesAny(Snowflake... roles)
      Creates a group defined as all users that have any of the given roles.
      Parameters:
      roles - The roles.
      Returns:
      The group.

    • hasRolesAll

      public static GuildGroup hasRolesAll(Flux<Snowflake> roles)
      Creates a group defined as all users that have all of the given roles.
      Parameters:
      roles - The roles. The issued values may vary over time (between subscriptions).
      Returns:
      The group.

    • hasRolesAll

      public static GuildGroup hasRolesAll(Mono<? extends Collection<Snowflake>> roles)
      Creates a group defined as all users that have all of the given roles.
      Parameters:
      roles - The roles. The issued values may vary over time (between subscriptions).
      Returns:
      The group.

    • hasRolesAll

      public static GuildGroup hasRolesAll(Supplier<? extends Collection<Snowflake>> roles)
      Creates a group defined as all users that have all of the given roles.
      Parameters:
      roles - The roles. The issued values may vary over time.
      Returns:
      The group.

    • hasRolesAll

      public static GuildGroup hasRolesAll(Collection<Snowflake> roles)
      Creates a group defined as all users that have all of the given roles.
      Parameters:
      roles - The roles.
      Returns:
      The group.

    • hasRolesAll

      public static GuildGroup hasRolesAll(Snowflake... roles)
      Creates a group defined as all users that have all of the given roles.
      Parameters:
      roles - The roles.
      Returns:
      The group.

    • hasGuildPermissions

      public static GuildGroup hasGuildPermissions(Mono<discord4j.rest.util.PermissionSet> permissions)
      Creates a group defined as all users that have the given permissions in the guild.
      Parameters:
      permissions - The permissions. The issued value may vary over time.
      Returns:
      The group.

    • hasGuildPermissions

      public static GuildGroup hasGuildPermissions(Supplier<discord4j.rest.util.PermissionSet> permissions)
      Creates a group defined as all users that have the given permissions in the guild.
      Parameters:
      permissions - The permissions. The issued value may vary over time.
      Returns:
      The group.

    • hasGuildPermissions

      public static GuildGroup hasGuildPermissions(discord4j.rest.util.PermissionSet permissions)
      Creates a group defined as all users that have the given permissions in the guild.
      Parameters:
      permissions - The permissions.
      Returns:
      The group.

    • hasChannelPermissions

      public static Group hasChannelPermissions(Mono<discord4j.rest.util.PermissionSet> permissions)
      Creates a group defined as all users that have the given permissions in the channel.
      Parameters:
      permissions - The permissions. The issued value may vary over time.
      Returns:
      The group.

    • hasChannelPermissions

      public static Group hasChannelPermissions(Supplier<discord4j.rest.util.PermissionSet> permissions)
      Creates a group defined as all users that have the given permissions in the channel.
      Parameters:
      permissions - The permissions. The issued value may vary over time.
      Returns:
      The group.

    • hasChannelPermissions

      public static Group hasChannelPermissions(discord4j.rest.util.PermissionSet permissions)
      Creates a group defined as all users that have the given permissions in the channel.
      Parameters:
      permissions - The permissions.
      Returns:
      The group.