Package org.javacord.api.entity.channel

Class ServerChannelUpdater

    • Constructor Detail

      • ServerChannelUpdater

        protected ServerChannelUpdater​()
        Creates a new server channel updater without delegate.

      • ServerChannelUpdater

        public ServerChannelUpdater​(ServerChannel channel)
        Creates a new server channel updater.
        Parameters:
        channel - The channel to update.

    • Method Detail

      • setAuditLogReason

        public ServerChannelUpdater 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 ServerChannelUpdater setName​(String name)
        Queues the name to be updated.
        Parameters:
        name - The new name of the channel.
        Returns:
        The current instance in order to chain call methods.

      • setRawPosition

        public ServerChannelUpdater setRawPosition​(int rawPosition)
        Queues the raw position to be updated.
        Parameters:
        rawPosition - The new position of the channel. If you want to update the position based on other channels, make sure to use ServerChannel.getRawPosition() instead of ServerChannel.getPosition()!
        Returns:
        The current instance in order to chain call methods.

      • addPermissionOverwrite

        public <T extends Permissionable & DiscordEntity> ServerChannelUpdater addPermissionOverwrite​(T permissionable,
                                                                                              Permissions permissions)
        Adds a permission overwrite for the given entity.
        Type Parameters:
        T - The type of entity to hold the permission, usually User or Role
        Parameters:
        permissionable - The entity whose permissions should be overwritten.
        permissions - The permission overwrites.
        Returns:
        The current instance in order to chain call methods.

      • removePermissionOverwrite

        public <T extends Permissionable & DiscordEntity> ServerChannelUpdater removePermissionOverwrite​(T permissionable)
        Removes a permission overwrite for the given entity.
        Type Parameters:
        T - The type of entity to hold the permission, usually User or Role
        Parameters:
        permissionable - The entity which permission overwrite should be removed.
        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.