net.dv8tion.jda.api.managers.channel.attribute.ICategorizableChannelManager Maven / Gradle / Ivy
Show all versions of JDA Show documentation
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.managers.channel.attribute;
import net.dv8tion.jda.api.Permission;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.IPermissionHolder;
import net.dv8tion.jda.api.entities.PermissionOverride;
import net.dv8tion.jda.api.entities.channel.attribute.ICategorizableChannel;
import net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer;
import net.dv8tion.jda.api.entities.channel.concrete.Category;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.managers.channel.ChannelManager;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Manager abstraction to set the {@link Category Parent Category} of a {@link ICategorizableChannel categorizable channel}.
*
* @param The channel type
* @param The manager type
*/
public interface ICategorizableChannelManager>
extends ChannelManager, IPermissionContainerManager
{
/**
* Sets the {@link Category Parent Category}
* of the selected {@link GuildChannel GuildChannel}.
*
* @param category
* The new parent for the selected {@link GuildChannel GuildChannel}
*
* @throws IllegalStateException
* If the target is a category itself
* @throws IllegalArgumentException
* If the provided category is not from the same Guild
*
* @return ChannelManager for chaining convenience
*
* @since 3.4.0
*/
@Nonnull
@CheckReturnValue
M setParent(@Nullable Category category);
/**
* Syncs all {@link PermissionOverride PermissionOverrides} of this GuildChannel with
* its parent ({@link Category Category}).
*
* After this operation, all {@link PermissionOverride PermissionOverrides}
* will be exactly the same as the ones from the parent.
*
That means that all current PermissionOverrides are lost!
*
*
This behaves as if calling {@link #sync(IPermissionContainer)} with this GuildChannel's {@link ICategorizableChannel#getParentCategory()} Parent}.
*
* @throws IllegalStateException
* If this GuildChannel has no parent
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link Permission#MANAGE_PERMISSIONS Permission.MANAGE_PERMISSIONS}
* in this channel or {@link IPermissionHolder#canSync(IPermissionContainer, IPermissionContainer)} is false for the self member.
*
* @return ChannelManager for chaining convenience
*
* @see Discord Documentation - Permission Syncing
*/
@Nonnull
@CheckReturnValue
default M sync()
{
if (!(getChannel() instanceof ICategorizableChannel))
throw new IllegalStateException("sync() requires that the channel be categorizable as it syncs the channel to the parent category.");
ICategorizableChannel categorizableChannel = (ICategorizableChannel) getChannel();
if (categorizableChannel.getParentCategory() == null)
throw new IllegalStateException("sync() requires a parent category");
return sync(categorizableChannel.getParentCategory());
}
/**
* Syncs all {@link PermissionOverride PermissionOverrides} of this GuildChannel with
* the given ({@link GuildChannel GuildChannel}).
*
*
After this operation, all {@link PermissionOverride PermissionOverrides}
* will be exactly the same as the ones from the syncSource.
*
That means that all current PermissionOverrides are lost!
*
*
This will only work for Channels of the same {@link Guild Guild}!.
*
* @param syncSource
* The GuildChannel from where all PermissionOverrides should be copied from
*
* @throws IllegalArgumentException
* If the given snySource is {@code null}, this GuildChannel or from a different Guild.
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link Permission#MANAGE_PERMISSIONS Permission.MANAGE_PERMISSIONS}
* in this channel or {@link IPermissionHolder#canSync(IPermissionContainer, IPermissionContainer)} is false for the self member.
*
* @return ChannelManager for chaining convenience
*
* @see Discord Documentation - Permission Syncing
*/
@Nonnull
@CheckReturnValue
M sync(@Nonnull IPermissionContainer syncSource);
}