Class DiscordUtil

Method Details

• sanitizeChannelName

  public String sanitizeChannelName(String channelName)

  Method that removes the # in the channel name.

  Parameters:

  channelName -

  Returns:

• isValidFilePath

  public boolean isValidFilePath(String fileLocation)

• sendMessage

  public discord4j.core.object.entity.Message sendMessage(discord4j.core.object.entity.channel.MessageChannel channel, String message)

• sendMessageAsync

  public Mono<discord4j.core.object.entity.Message> sendMessageAsync(discord4j.core.object.entity.channel.MessageChannel channel, String message)

• sendMessage

  public discord4j.core.object.entity.Message sendMessage(String channelName, String message)

  Method to send a message to a channel.

  Parameters:

  channelName -

  message -

  Returns:

• sendMessageAsync

  public Mono<discord4j.core.object.entity.Message> sendMessageAsync(String channelName, String message)

• sendPrivateMessage

  public void sendPrivateMessage(discord4j.core.object.entity.User user, String message)

  Method to send private messages to a user.

  Parameters:

  user -

  message -

• sendPrivateMessage

  public void sendPrivateMessage(String userName, String message)

  Method to send private messages to a user.

  Parameters:

  userName -

  message -

• sendPrivateMessage

  public void sendPrivateMessage(discord4j.core.object.entity.channel.PrivateChannel channel, String message)

• sendMessageEmbed

  public discord4j.core.object.entity.Message sendMessageEmbed(discord4j.core.object.entity.channel.GuildMessageChannel channel, discord4j.core.spec.EmbedCreateSpec embed)

• sendMessageEmbedAsync

  public Mono<discord4j.core.object.entity.Message> sendMessageEmbedAsync(discord4j.core.object.entity.channel.GuildMessageChannel channel, discord4j.core.spec.EmbedCreateSpec embed)

• sendMessageEmbed

  public discord4j.core.object.entity.Message sendMessageEmbed(String channelName, discord4j.core.spec.EmbedCreateSpec embed)

  Method to send embed messages.

  Parameters:

  channelName -

  embed -

  Returns:

• sendMessageEmbedAsync

  public Mono<discord4j.core.object.entity.Message> sendMessageEmbedAsync(String channelName, discord4j.core.spec.EmbedCreateSpec embed)

• sendMessageEmbed

  public discord4j.core.object.entity.Message sendMessageEmbed(discord4j.core.object.entity.channel.GuildMessageChannel channel, String color, String message)

  Method to send embed messages.

  Parameters:

  channel -

  message -

  color -

  Returns:

• sendMessageEmbedAsync

  public Mono<discord4j.core.object.entity.Message> sendMessageEmbedAsync(discord4j.core.object.entity.channel.GuildMessageChannel channel, String color, String message)

• sendMessageEmbed

  public discord4j.core.object.entity.Message sendMessageEmbed(String channelName, String color, String message)

  Method to send embed messages.

  Parameters:

  channelName -

  message -

  color -

  Returns:

• sendFile

  public discord4j.core.object.entity.Message sendFile(discord4j.core.object.entity.channel.GuildMessageChannel channel, String message, String fileLocation)

• sendFileAsync

  public Mono<discord4j.core.object.entity.Message> sendFileAsync(discord4j.core.object.entity.channel.GuildMessageChannel channel, String message, String fileLocation)

• sendFileAsync

  public Mono<discord4j.core.object.entity.Message> sendFileAsync(discord4j.core.object.entity.channel.GuildMessageChannel channel, String message, DiscordUtil.MessageCreateFile file)

• sendFile

  public discord4j.core.object.entity.Message sendFile(String channelName, String message, String fileLocation)

  Method to send a file to a channel.

  Parameters:

  channelName -

  message -

  fileLocation -

  Returns:

• sendFileAsync

  public Mono<discord4j.core.object.entity.Message> sendFileAsync(String channelName, String message, String fileLocation)

• sendFile

  public discord4j.core.object.entity.Message sendFile(discord4j.core.object.entity.channel.GuildMessageChannel channel, String fileLocation)

  Method to send a file to a channel.

  Parameters:

  channel -

  fileLocation -

  Returns:

• sendFile

  public discord4j.core.object.entity.Message sendFile(String channelName, String fileLocation)

  Method to send a file to a channel.

  Parameters:

  channelName -

  fileLocation -

  Returns:

• addReaction

  public void addReaction(discord4j.core.object.entity.Message message, discord4j.core.object.reaction.ReactionEmoji emoji)

  Method that adds a reaction to a message.

  Parameters:

  message - The message object

  emoji - The reaction object

• addReactions

  public void addReactions(discord4j.core.object.entity.Message message, discord4j.core.object.reaction.ReactionEmoji... emojis)

  Method that adds multiple reactions to a message.

  Parameters:

  message - The message object

  emojis - The reaction objects

• addReaction

  public void addReaction(discord4j.core.object.entity.Message message, String emoji)

  Method that adds a reaction to a message.

  Parameters:

  message - The message object

  emoji - The emoji unicode

• addReactions

  public void addReactions(discord4j.core.object.entity.Message message, String... emojis)

  Method that adds a reaction to a message.

  Parameters:

  message - The message object

  emojis - The emoji unicodes

• canChannelPublish

  public boolean canChannelPublish(String channelName)

  * Indicates if the channel is a type that is allowed to publish crossposts

  Parameters:

  channelName - The channel to check

  Returns:

• canChannelPublish

  public boolean canChannelPublish(discord4j.core.object.entity.channel.GuildMessageChannel channel)

  * Indicates if the channel is a type that is allowed to publish crossposts

  Parameters:

  channel - The channel to check

  Returns:

• getChannel

  public discord4j.core.object.entity.channel.GuildMessageChannel getChannel(String channelName)

  Method to return a channel object by its name.

  Parameters:

  channelName - - The name of the channel.

  Returns:

• getChannelAsync

  public Mono<discord4j.core.object.entity.channel.GuildMessageChannel> getChannelAsync(String channelName)

• getChannelAsync

  public Mono<discord4j.core.object.entity.channel.GuildMessageChannel> getChannelAsync(String channelName, Predicate<? super discord4j.core.object.entity.channel.GuildChannel> filter)

• getAllChannelInfo

  public Map<String,Map<String,String>> getAllChannelInfo()

• getAllChannelInfoAsync

  public Flux<discord4j.core.object.entity.channel.GuildChannel> getAllChannelInfoAsync(Map<String,Map<String,String>> data)

• getChannelByID

  public discord4j.core.object.entity.channel.GuildMessageChannel getChannelByID(String channelId)

  Method to return a channel object by its ID.

  Parameters:

  channelId - - The string ID of the channel

  Returns:

• getChannelByIDAsync

  public Mono<discord4j.core.object.entity.channel.GuildMessageChannel> getChannelByIDAsync(String channelId)

• getUser

  public discord4j.core.object.entity.User getUser(String userName)

• getUserAsync

  public Mono<discord4j.core.object.entity.User> getUserAsync(String userName)

  Method to return a user object by its name.

  Parameters:

  userName - - The user's name.

  Returns:

• getUserById

  public discord4j.core.object.entity.User getUserById(long userId)

• getUserByIdAsync

  public Mono<discord4j.core.object.entity.User> getUserByIdAsync(long userId)

  Method to return a user object by its id.

  Parameters:

  userId - - The ID of the user.

  Returns:

• getUserWithDiscriminator

  @Deprecated(since="3.10.0.0", forRemoval=true) public discord4j.core.object.entity.User getUserWithDiscriminator(String userName, String discriminator)

  Deprecated, for removal: This API element is subject to removal in a future version.

  Discriminators have been removed from Discord

• getUserWithDiscriminatorAsync

  @Deprecated(since="3.10.0.0", forRemoval=true) public Mono<discord4j.core.object.entity.User> getUserWithDiscriminatorAsync(String userName, String discriminator)

  Deprecated, for removal: This API element is subject to removal in a future version.

  Discriminators have been removed from Discord

  Method to return a user object by its name and its discriminator.

  Parameters:

  userName -

  discriminator -

  Returns:

• getRolesAsync

  public Flux<discord4j.core.object.entity.Role> getRolesAsync(String... roleNames)

  Search for Discord roles by display name or mention and return a Flux
  Matching is performed case insensitively
  The Flux is sorted so the roles are returned in permission order, as displayed in the Discord roles list of the Guild settings. The sort starts with the cloest role to @everyone, and then continues up

  Parameters:

  roleNames - The role names or mentions to find

  Returns:

  a Flux containing matching roles

• getRole

  public discord4j.core.object.entity.Role getRole(String roleName)

• getRoleAsync

  public Mono<discord4j.core.object.entity.Role> getRoleAsync(String roleName)

  Method to return a role object by its name.

  Parameters:

  roleName -

  Returns:

• getRoleByID

  public discord4j.core.object.entity.Role getRoleByID(String id)

• getRoleByIDAsync

  public Mono<discord4j.core.object.entity.Role> getRoleByIDAsync(String id)

  Method that returns a role by its ID.

  Parameters:

  id -

  Returns:

• getRoleObjects

  public discord4j.core.object.entity.Role[] getRoleObjects(String... roles)

  Method to get an array of role objects by a string of role names.

  Parameters:

  roles -

  Returns:

• getRoleObjectsAsync

  public Mono<discord4j.core.object.entity.Role[]> getRoleObjectsAsync(String... roles)

• getUserRoles

  public discord4j.core.object.entity.Role[] getUserRoles(discord4j.core.object.entity.User user)

  Method to get a list of a user's roles.

  Parameters:

  user -

  Returns:

• getUserRolesAsync

  public Mono<discord4j.core.object.entity.Role[]> getUserRolesAsync(discord4j.core.object.entity.User user)

• getUserRoles

  public discord4j.core.object.entity.Role[] getUserRoles(String userId)

  Method to get a list of a user's roles.

  Parameters:

  userId -

  Returns:

• getUserRolesAsync

  public Mono<discord4j.core.object.entity.Role[]> getUserRolesAsync(String userId)

• editUserRoles

  public void editUserRoles(discord4j.core.object.entity.User user, discord4j.core.object.entity.Role... roles)

  Method to edit roles on a user, multiple can be set at once to replace the current ones.

  Parameters:

  user -

  roles -

• editUserRoles

  public void editUserRoles(String userId, discord4j.core.object.entity.Role... roles)

  Method to edit roles on a user, multiple can be set at once to replace the current ones.

  Parameters:

  userId -

  roles -

• addRole

  public void addRole(discord4j.core.object.entity.Role role, discord4j.core.object.entity.User user)

  Method to set a role on a user.

  Parameters:

  role -

  user -

• addRole

  public void addRole(String roleName, String userName)

  Method to set a role on a user.

  Parameters:

  roleName -

  userName -

• addRole

  public void addRole(String roleName, discord4j.core.object.entity.User user)

  Method to set a role on a user.

  Parameters:

  roleName -

  user -

• removeRole

  public void removeRole(discord4j.core.object.entity.Role role, discord4j.core.object.entity.User user)

  Method to remove a role on a user.

  Parameters:

  role -

  user -

• removeRole

  public void removeRole(String roleName, String userName)

  Method to remove a role on a user.

  Parameters:

  roleName -

  userName -

• createRole

  public void createRole(String roleName)

  Method to create a new role.

  Parameters:

  roleName -

• deleteRole

  public void deleteRole(discord4j.core.object.entity.Role role)

  Method to delete a role.

  Parameters:

  role -

• deleteRole

  public void deleteRole(String roleName)

  Method to delete a role.

  Parameters:

  roleName -

• getGuildRoles

  public List<discord4j.core.object.entity.Role> getGuildRoles()

  Method that gets a list of guild roles.

  Returns:

• getGuildRolesAsync

  public Mono<List<discord4j.core.object.entity.Role>> getGuildRolesAsync()

• isAdministrator

  public boolean isAdministrator(discord4j.core.object.entity.User user)

  Method to check if someone is an administrator.

  Parameters:

  user -

  Returns:

• isAdministratorAsync

  public Mono<Boolean> isAdministratorAsync(discord4j.core.object.entity.User user)

• isAdministrator

  public boolean isAdministrator(String userName)

  Method to check if someone is an administrator.

  Parameters:

  userName -

  Returns:

• isAdministratorAsync

  public Mono<Boolean> isAdministratorAsync(String userName)

• bulkDelete

  public void bulkDelete(discord4j.core.object.entity.channel.GuildMessageChannel channel, int amount)

  Method to bulk delete messages from a channel.

  Parameters:

  channel -

  amount -

• bulkDelete

  public void bulkDelete(String channelName, int amount)

  Method to bulk delete messages from a channel.

  Parameters:

  channelName -

  amount -

• bulkDeleteMessages

  public void bulkDeleteMessages(discord4j.core.object.entity.channel.GuildMessageChannel channel, discord4j.core.object.entity.Message... list)

  Method to bulk delete messages from a channel.

  Parameters:

  channel -

  list -

• bulkDeleteMessages

  public void bulkDeleteMessages(String channelName, discord4j.core.object.entity.Message... messages)

  Method to bulk delete messages from a channel.

  Parameters:

  channelName -

  messages -

• deleteMessage

  public void deleteMessage(discord4j.core.object.entity.Message message)

  Method to delete a message.

  Parameters:

  message -

• setCompeting

  public void setCompeting(String competingIn)

• setListening

  public void setListening(String listeningTo)

• setWatching

  public void setWatching(String watching)

• setPlaying

  public void setPlaying(String game)

• setStreaming

  public void setStreaming(String streaming, String url)

• resetPresence

  public void resetPresence()

• setGame

  public void setGame(String game)

  Method to set the current game.

  Parameters:

  game -

• setStream

  public void setStream(String game, String url)

  Method to set the current game and stream.

  Parameters:

  game -

  url -

• removeGame

  public void removeGame()

  Method to remove the current game or reset the streaming status.

• getUsers

  public List<discord4j.core.object.entity.User> getUsers()

  Method that gets all server members

  Returns:

• getUsersAsync

  public Mono<List<discord4j.core.object.entity.User>> getUsersAsync()

• getColor

  public Color getColor(String color)

  Method to get a color object.

  Parameters:

  color -

  Returns:

• getMessageById

  public discord4j.core.object.entity.Message getMessageById(String channelName, String messageId)

  Method to return a message by its id.

  Parameters:

  channelName -

  messageId -

  Returns:

• editMessageContent

  public void editMessageContent(discord4j.core.object.entity.Message message, String newMessage)

  Method to edit message content.

  Parameters:

  message -

  newMessage -

• editMessageEmbed

  public void editMessageEmbed(discord4j.core.object.entity.Message message, discord4j.core.spec.EmbedCreateSpec newEmbed)

  Method to edit message embeds.

  Parameters:

  message -

  newEmbed -

• getMessagesBefore

  public List<discord4j.core.object.entity.Message> getMessagesBefore(String channelName, String messageId)

  Method to return a list of all messages before the given message.

  Parameters:

  channelName -

  messageId -

  Returns:

• getLastMessage

  public discord4j.core.object.entity.Message getLastMessage(String channelName)

  Method to return a the last message of a given channel.

  Parameters:

  channelName -

  Returns:

• channelId

  public static Optional<Snowflake> channelId(discord4j.core.object.entity.channel.Channel channel)

• channelIdAsString

  public static String channelIdAsString(discord4j.core.object.entity.channel.Channel channel)

• channelName

  public static String channelName(discord4j.core.object.entity.channel.Channel channel)