Package org.javacord.api.entity.server

Class ServerUpdater


  • public class ServerUpdater
extends Object
    This class can be used to update the settings of a server.

    • Constructor Detail

      • ServerUpdater

        public ServerUpdater​(Server server)
        Creates a new server updater.
        Parameters:
        server - The server to update.

    • Method Detail

      • setAuditLogReason

        public ServerUpdater setAuditLogReason​(String reason)
        Sets the reason for this update. This reason will be visible in the audit log entry(s).
        Parameters:
        reason - The reason for this update.
        Returns:
        The current instance in order to chain call methods.

      • setName

        public ServerUpdater setName​(String name)
        Queues the name to be updated.
        Parameters:
        name - The new name of the server.
        Returns:
        The current instance in order to chain call methods.

      • setRegion

        public ServerUpdater setRegion​(Region region)
        Queues the region to be updated.
        Parameters:
        region - The new region of the server.
        Returns:
        The current instance in order to chain call methods.

      • setExplicitContentFilterLevel

        public ServerUpdater setExplicitContentFilterLevel​(ExplicitContentFilterLevel explicitContentFilterLevel)
        Queues the explicit content filter level to be updated.
        Parameters:
        explicitContentFilterLevel - The new explicit content filter level of the server.
        Returns:
        The current instance in order to chain call methods.

      • setVerificationLevel

        public ServerUpdater setVerificationLevel​(VerificationLevel verificationLevel)
        Queues the verification level to be updated.
        Parameters:
        verificationLevel - The new verification level of the server.
        Returns:
        The current instance in order to chain call methods.

      • setDefaultMessageNotificationLevel

        public ServerUpdater setDefaultMessageNotificationLevel​(DefaultMessageNotificationLevel defaultMessageNotificationLevel)
        Queues the default message notification level to be updated.
        Parameters:
        defaultMessageNotificationLevel - The new default message notification level of the server.
        Returns:
        The current instance in order to chain call methods.

      • setAfkChannel

        public ServerUpdater setAfkChannel​(ServerVoiceChannel afkChannel)
        Queues the afk channel to be updated.
        Parameters:
        afkChannel - The new afk channel of the server.
        Returns:
        The current instance in order to chain call methods.

      • removeAfkChannel

        public ServerUpdater removeAfkChannel​()
        Queues the afk channel to be removed.
        Returns:
        The current instance in order to chain call methods.

      • setAfkTimeoutInSeconds

        public ServerUpdater setAfkTimeoutInSeconds​(int afkTimeout)
        Queues the afk timeout in seconds to be updated.
        Parameters:
        afkTimeout - The new afk timeout in seconds of the server.
        Returns:
        The current instance in order to chain call methods.

      • setIcon

        public ServerUpdater setIcon​(BufferedImage icon)
        Queues the icon to be updated. This method assumes the file type is "png"!
        Parameters:
        icon - The new icon of the server.
        Returns:
        The current instance in order to chain call methods.

      • setIcon

        public ServerUpdater setIcon​(BufferedImage icon,
                             String fileType)
        Queues the icon to be updated.
        Parameters:
        icon - The new icon of the server.
        fileType - The type of the icon, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.

      • setIcon

        public ServerUpdater setIcon​(File icon)
        Queues the icon to be updated.
        Parameters:
        icon - The new icon of the server.
        Returns:
        The current instance in order to chain call methods.

      • setIcon

        public ServerUpdater setIcon​(Icon icon)
        Queues the icon to be updated.
        Parameters:
        icon - The new icon of the server.
        Returns:
        The current instance in order to chain call methods.

      • setIcon

        public ServerUpdater setIcon​(URL icon)
        Queues the icon to be updated.
        Parameters:
        icon - The new icon of the server.
        Returns:
        The current instance in order to chain call methods.

      • setIcon

        public ServerUpdater setIcon​(byte[] icon)
        Queues the icon to be updated. This method assumes the file type is "png"!
        Parameters:
        icon - The new icon of the server.
        Returns:
        The current instance in order to chain call methods.

      • setIcon

        public ServerUpdater setIcon​(byte[] icon,
                             String fileType)
        Queues the icon to be updated.
        Parameters:
        icon - The new icon of the server.
        fileType - The type of the icon, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.

      • setIcon

        public ServerUpdater setIcon​(InputStream icon)
        Queues the icon to be updated. This method assumes the file type is "png"!
        Parameters:
        icon - The new icon of the server.
        Returns:
        The current instance in order to chain call methods.

      • setIcon

        public ServerUpdater setIcon​(InputStream icon,
                             String fileType)
        Queues the icon to be updated.
        Parameters:
        icon - The new icon of the server.
        fileType - The type of the icon, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.

      • removeIcon

        public ServerUpdater removeIcon​()
        Queues the icon to be removed.
        Returns:
        The current instance in order to chain call methods.

      • setOwner

        public ServerUpdater setOwner​(User owner)
        Queues the owner to be updated. You must be the owner of this server in order to transfer it!
        Parameters:
        owner - The new owner of the server.
        Returns:
        The current instance in order to chain call methods.

      • setSplash

        public ServerUpdater setSplash​(BufferedImage splash)
        Queues the splash to be updated. This method assumes the file type is "png"!
        Parameters:
        splash - The new splash of the server.
        Returns:
        The current instance in order to chain call methods.

      • setSplash

        public ServerUpdater setSplash​(BufferedImage splash,
                               String fileType)
        Queues the splash to be updated. Requires ServerFeature.INVITE_SPLASH.
        Parameters:
        splash - The new splash of the server.
        fileType - The type of the splash, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.

      • setSplash

        public ServerUpdater setSplash​(File splash)
        Queues the splash to be updated. Requires ServerFeature.INVITE_SPLASH.
        Parameters:
        splash - The new splash of the server.
        Returns:
        The current instance in order to chain call methods.

      • setSplash

        public ServerUpdater setSplash​(Icon splash)
        Queues the splash to be updated. Requires ServerFeature.INVITE_SPLASH.
        Parameters:
        splash - The new splash of the server.
        Returns:
        The current instance in order to chain call methods.

      • setSplash

        public ServerUpdater setSplash​(URL splash)
        Queues the splash to be updated. Requires ServerFeature.INVITE_SPLASH.
        Parameters:
        splash - The new splash of the server.
        Returns:
        The current instance in order to chain call methods.

      • setSplash

        public ServerUpdater setSplash​(byte[] splash)
        Queues the splash to be updated. Requires ServerFeature.INVITE_SPLASH. This method assumes the file type is "png"!
        Parameters:
        splash - The new splash of the server.
        Returns:
        The current instance in order to chain call methods.

      • setSplash

        public ServerUpdater setSplash​(byte[] splash,
                               String fileType)
        Queues the splash to be updated. Requires ServerFeature.INVITE_SPLASH.
        Parameters:
        splash - The new splash of the server.
        fileType - The type of the splash, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.

      • setSplash

        public ServerUpdater setSplash​(InputStream splash)
        Queues the splash to be updated. Requires ServerFeature.INVITE_SPLASH. This method assumes the file type is "png"!
        Parameters:
        splash - The new splash of the server.
        Returns:
        The current instance in order to chain call methods.

      • setSplash

        public ServerUpdater setSplash​(InputStream splash,
                               String fileType)
        Queues the splash to be updated. Requires ServerFeature.INVITE_SPLASH.
        Parameters:
        splash - The new splash of the server.
        fileType - The type of the splash, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.

      • setBanner

        public ServerUpdater setBanner​(BufferedImage banner)
        Queues the banner to be updated. Requires ServerFeature.BANNER. This method assumes the file type is "png"!
        Parameters:
        banner - The new banner of the server.
        Returns:
        The current instance in order to chain call methods.

      • setBanner

        public ServerUpdater setBanner​(BufferedImage banner,
                               String fileType)
        Queues the banner to be updated. Requires ServerFeature.BANNER.
        Parameters:
        banner - The new banner of the server.
        fileType - The type of the banner, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.

      • setBanner

        public ServerUpdater setBanner​(File banner)
        Queues the banner to be updated. Requires ServerFeature.BANNER.
        Parameters:
        banner - The new banner of the server.
        Returns:
        The current instance in order to chain call methods.

      • setBanner

        public ServerUpdater setBanner​(Icon banner)
        Queues the banner to be updated. Requires ServerFeature.BANNER.
        Parameters:
        banner - The new banner of the server.
        Returns:
        The current instance in order to chain call methods.

      • setBanner

        public ServerUpdater setBanner​(URL banner)
        Queues the banner to be updated. Requires ServerFeature.BANNER.
        Parameters:
        banner - The new banner of the server.
        Returns:
        The current instance in order to chain call methods.

      • setBanner

        public ServerUpdater setBanner​(byte[] banner)
        Queues the banner to be updated. Requires ServerFeature.BANNER. This method assumes the file type is "png"!
        Parameters:
        banner - The new banner of the server.
        Returns:
        The current instance in order to chain call methods.

      • setBanner

        public ServerUpdater setBanner​(byte[] banner,
                               String fileType)
        Queues the banner to be updated. Requires ServerFeature.BANNER.
        Parameters:
        banner - The new banner of the server.
        fileType - The type of the banner, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.

      • setBanner

        public ServerUpdater setBanner​(InputStream banner)
        Queues the banner to be updated. Requires ServerFeature.BANNER. This method assumes the file type is "png"!
        Parameters:
        banner - The new banner of the server.
        Returns:
        The current instance in order to chain call methods.

      • setBanner

        public ServerUpdater setBanner​(InputStream banner,
                               String fileType)
        Queues the banner to be updated. Requires ServerFeature.BANNER.
        Parameters:
        banner - The new banner of the server.
        fileType - The type of the banner, e.g. "png" or "jpg".
        Returns:
        The current instance in order to chain call methods.

      • removeBanner

        public ServerUpdater removeBanner​()
        Queues the banner to be removed. Requires ServerFeature.BANNER.
        Returns:
        The current instance in order to chain call methods.

      • setRulesChannel

        public ServerUpdater setRulesChannel​(ServerTextChannel rulesChannel)
        Queues the rules channel to be updated. Server has to be "PUBLIC".
        Parameters:
        rulesChannel - The new rules channel of the server.
        Returns:
        The current instance in order to chain call methods.

      • removeRulesChannel

        public ServerUpdater removeRulesChannel​()
        Queues the rules channel to be removed. Server has to be "PUBLIC".
        Returns:
        The current instance in order to chain call methods.

      • setModeratorsOnlyChannel

        public ServerUpdater setModeratorsOnlyChannel​(ServerTextChannel moderatorsOnlyChannel)
        Queues the moderators-only channel to be updated. Server has to be "PUBLIC".
        Parameters:
        moderatorsOnlyChannel - The new moderators-only channel of the server.
        Returns:
        The current instance in order to chain call methods.

      • removeModeratorsOnlyChannel

        public ServerUpdater removeModeratorsOnlyChannel​()
        Queues the moderators-only channel to be removed. Server has to be "PUBLIC".
        Returns:
        The current instance in order to chain call methods.

      • setPreferredLocale

        public ServerUpdater setPreferredLocale​(Locale locale)
        Queues the preferred locale of a public guild to be updated.
        Parameters:
        locale - The preferred locale of the public server.
        Returns:
        The current instance in order to chain call methods.

      • setSystemChannel

        public ServerUpdater setSystemChannel​(ServerTextChannel systemChannel)
        Queues the system channel to be updated.
        Parameters:
        systemChannel - The new system channel of the server.
        Returns:
        The current instance in order to chain call methods.

      • removeSystemChannel

        public ServerUpdater removeSystemChannel​()
        Queues the system channel to be removed.
        Returns:
        The current instance in order to chain call methods.

      • setNickname

        public ServerUpdater setNickname​(User user,
                                 String nickname)
        Queues a user's nickname to be updated.
        Parameters:
        user - The user whose nickname should be updated.
        nickname - The new nickname of the user.
        Returns:
        The current instance in order to chain call methods.

      • setMuted

        public ServerUpdater setMuted​(User user,
                              boolean muted)
        Queues a user's muted state to be updated.
        Parameters:
        user - The user whose muted state should be updated.
        muted - The new muted state of the user.
        Returns:
        The current instance in order to chain call methods.

      • setDeafened

        public ServerUpdater setDeafened​(User user,
                                 boolean deafened)
        Queues a user's deafened state to be updated.
        Parameters:
        user - The user whose deafened state should be updated.
        deafened - The new deafened state of the user.
        Returns:
        The current instance in order to chain call methods.

      • setVoiceChannel

        public ServerUpdater setVoiceChannel​(User user,
                                     ServerVoiceChannel channel)
        Queues a moving a user to a different voice channel.
        Parameters:
        user - The user who should be moved.
        channel - The new voice channel of the user.
        Returns:
        The current instance in order to chain call methods.

      • reorderRoles

        public ServerUpdater reorderRoles​(List<Role> roles)
        Sets the new order for the server's roles.
        Parameters:
        roles - An ordered list with the new role positions.
        Returns:
        The current instance in order to chain call methods.

      • addRoleToUser

        public ServerUpdater addRoleToUser​(User user,
                                   Role role)
        Queues a role to be assigned to the user.
        Parameters:
        user - The server member the role should be added to.
        role - The role which should be added to the server member.
        Returns:
        The current instance in order to chain call methods.

      • addRolesToUser

        public ServerUpdater addRolesToUser​(User user,
                                    Collection<Role> roles)
        Queues a collection of roles to be assigned to the user.
        Parameters:
        user - The server member the role should be added to.
        roles - The roles which should be added to the server member.
        Returns:
        The current instance in order to chain call methods.

      • removeRoleFromUser

        public ServerUpdater removeRoleFromUser​(User user,
                                        Role role)
        Queues a role to be removed from the user.
        Parameters:
        user - The server member the role should be removed from.
        role - The role which should be removed from the user.
        Returns:
        The current instance in order to chain call methods.

      • removeRolesFromUser

        public ServerUpdater removeRolesFromUser​(User user,
                                         Collection<Role> roles)
        Queues a collection of roles to be removed from the user.
        Parameters:
        user - The server member the roles should be removed from.
        roles - The roles which should be removed from the user.
        Returns:
        The current instance in order to chain call methods.

      • removeAllRolesFromUser

        public ServerUpdater removeAllRolesFromUser​(User user)
        Queues all roles to be removed from the user.
        Parameters:
        user - The server member the roles should be removed from.
        Returns:
        The current instance in order to chain call methods.

      • update

        public CompletableFuture<Void> update​()
        Performs the queued updates.
        Returns:
        A future to check if the update was successful.