net.dv8tion.jda.api.entities.Category Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation
Show all versions of JDA Show documentation
Java wrapper for the popular chat & VOIP service: Discord https://discord.com
/*
* 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.entities;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.managers.channel.concrete.CategoryManager;
import net.dv8tion.jda.api.requests.restaction.ChannelAction;
import net.dv8tion.jda.api.requests.restaction.order.CategoryOrderAction;
import net.dv8tion.jda.api.requests.restaction.order.ChannelOrderAction;
import net.dv8tion.jda.api.requests.restaction.order.OrderAction;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
/**
* Represents a channel category in the official Discord API.
*
Categories are used to keep order in a Guild by dividing the channels into groups.
*
* @since 3.4.0
*
* @see Guild#getCategoryCache()
* @see Guild#getCategories()
* @see Guild#getCategoriesByName(String, boolean)
* @see Guild#getCategoryById(long)
*
* @see JDA#getCategoryCache()
* @see JDA#getCategories()
* @see JDA#getCategoriesByName(String, boolean)
* @see JDA#getCategoryById(long)
*/
public interface Category extends GuildChannel, ICopyableChannel, IPositionableChannel, IPermissionContainer, IMemberContainer
{
/**
* All {@link GuildChannel Channels} listed
* for this Category
*
This may contain {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannels},
* and {@link net.dv8tion.jda.api.entities.TextChannel TextChannels}!
*
* @return Immutable list of all child channels
*/
@Nonnull
default List getChannels()
{
List channels = new ArrayList<>();
channels.addAll(getTextChannels());
channels.addAll(getVoiceChannels());
channels.addAll(getStageChannels());
channels.addAll(getNewsChannels());
Collections.sort(channels);
return Collections.unmodifiableList(channels);
}
/**
* All {@link net.dv8tion.jda.api.entities.TextChannel TextChannels}
* listed for this Category
*
* @return Immutable list of all child TextChannels
*/
@Nonnull
default List getTextChannels()
{
return Collections.unmodifiableList(getGuild().getTextChannelCache().stream()
.filter(channel -> equals(channel.getParentCategory()))
.sorted().collect(Collectors.toList()));
}
/**
* All {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannels}
* listed for this Category
*
* @return Immutable list of all child NewsChannels
*/
@Nonnull
default List getNewsChannels()
{
return Collections.unmodifiableList(getGuild().getNewsChannelCache().stream()
.filter(channel -> equals(channel.getParentCategory()))
.sorted().collect(Collectors.toList()));
}
/**
* All {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannels}
* listed for this Category
*
* @return Immutable list of all child VoiceChannels
*/
@Nonnull
default List getVoiceChannels()
{
return Collections.unmodifiableList(getGuild().getVoiceChannelCache().stream()
.filter(channel -> equals(channel.getParentCategory()))
.sorted().collect(Collectors.toList()));
}
/**
* All {@link net.dv8tion.jda.api.entities.StageChannel StageChannel}
* listed for this Category
*
* @return Immutable list of all child StageChannel
*/
@Nonnull
default List getStageChannels()
{
return Collections.unmodifiableList(getGuild().getStageChannelCache().stream()
.filter(channel -> equals(channel.getParentCategory()))
.sorted().collect(Collectors.toList()));
}
/**
* Creates a new {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} with this Category as parent.
* For this to be successful, the logged in account has to have the
* {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL MANAGE_CHANNEL} Permission in this Category.
*
* This will copy all {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverrides} of this Category!
* Unless the bot is unable to sync it with this category due to permission escalation.
* See {@link IPermissionHolder#canSync(IPermissionContainer, IPermissionContainer)} for details.
*
*
Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} caused by
* the returned {@link net.dv8tion.jda.api.requests.RestAction RestAction} include the following:
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
*
The channel could not be created due to a permission discrepancy
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
*
The {@link net.dv8tion.jda.api.Permission#VIEW_CHANNEL VIEW_CHANNEL} permission was removed
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MAX_CHANNELS MAX_CHANNELS}
*
The maximum number of channels were exceeded
*
*
* @param name
* The name of the TextChannel to create
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL} permission
* @throws IllegalArgumentException
* If the provided name is {@code null} or empty or greater than 100 characters in length
*
* @return A specific {@link ChannelAction ChannelAction}
*
This action allows to set fields for the new TextChannel before creating it
*/
@Nonnull
@CheckReturnValue
ChannelAction createTextChannel(@Nonnull String name);
/**
* Creates a new {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannel} with this Category as parent.
* For this to be successful, the logged in account has to have the
* {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL MANAGE_CHANNEL} Permission in this Category.
*
* This will copy all {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverrides} of this Category!
* Unless the bot is unable to sync it with this category due to permission escalation.
* See {@link IPermissionHolder#canSync(IPermissionContainer, IPermissionContainer)} for details.
*
*
Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} caused by
* the returned {@link net.dv8tion.jda.api.requests.RestAction RestAction} include the following:
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
*
The channel could not be created due to a permission discrepancy
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
*
The {@link net.dv8tion.jda.api.Permission#VIEW_CHANNEL VIEW_CHANNEL} permission was removed
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MAX_CHANNELS MAX_CHANNELS}
*
The maximum number of channels were exceeded
*
*
* @param name
* The name of the VoiceChannel to create
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL} permission
* @throws IllegalArgumentException
* If the provided name is {@code null} or empty or greater than 100 characters in length
*
* @return A specific {@link ChannelAction ChannelAction}
*
This action allows to set fields for the new VoiceChannel before creating it
*/
@Nonnull
@CheckReturnValue
ChannelAction createVoiceChannel(@Nonnull String name);
/**
* Creates a new {@link net.dv8tion.jda.api.entities.StageChannel StageChannel} with this Category as parent.
* For this to be successful, the logged in account has to have the
* {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL MANAGE_CHANNEL} Permission in this Category.
*
* This will copy all {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverrides} of this Category!
* Unless the bot is unable to sync it with this category due to permission escalation.
* See {@link IPermissionHolder#canSync(IPermissionContainer, IPermissionContainer)} for details.
*
*
Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} caused by
* the returned {@link net.dv8tion.jda.api.requests.RestAction RestAction} include the following:
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
*
The channel could not be created due to a permission discrepancy
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
*
The {@link net.dv8tion.jda.api.Permission#VIEW_CHANNEL VIEW_CHANNEL} permission was removed
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MAX_CHANNELS MAX_CHANNELS}
*
The maximum number of channels were exceeded
*
*
* @param name
* The name of the StageChannel to create
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL} permission
* @throws IllegalArgumentException
* If the provided name is {@code null} or empty or greater than 100 characters in length
*
* @return A specific {@link ChannelAction ChannelAction}
*
This action allows to set fields for the new StageChannel before creating it
*/
@Nonnull
@CheckReturnValue
ChannelAction createStageChannel(@Nonnull String name);
/**
* Modifies the positional order of this Category's nested {@link #getTextChannels() TextChannels} and {@link #getNewsChannels() NewsChannels}.
*
This uses an extension of {@link ChannelOrderAction ChannelOrderAction}
* specialized for ordering the nested {@link net.dv8tion.jda.api.entities.TextChannel TextChannels}
* and {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannels} of this {@link net.dv8tion.jda.api.entities.Category Category}.
*
Like {@link ChannelOrderAction}, the returned {@link CategoryOrderAction CategoryOrderAction}
* can be used to move TextChannels/NewsChannels {@link OrderAction#moveUp(int) up},
* {@link OrderAction#moveDown(int) down}, or
* {@link OrderAction#moveTo(int) to} a specific position.
*
This uses ascending order with a 0 based index.
*
* Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} include:
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_CHANNEL UNNKOWN_CHANNEL}
*
One of the channels has been deleted before the completion of the task.
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
*
The currently logged in account was removed from the Guild.
*
*
* @return A {@link CategoryOrderAction CategoryOrderAction} for
* ordering the Category's {@link net.dv8tion.jda.api.entities.TextChannel TextChannels}
* and {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannels}.
*/
@Nonnull
@CheckReturnValue
CategoryOrderAction modifyTextChannelPositions();
/**
* Modifies the positional order of this Category's nested {@link #getVoiceChannels() VoiceChannels} and {@link #getStageChannels() StageChannels}.
*
This uses an extension of {@link ChannelOrderAction ChannelOrderAction}
* specialized for ordering the nested {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannels}
* and {@link net.dv8tion.jda.api.entities.StageChannel StageChannels} of this {@link net.dv8tion.jda.api.entities.Category Category}.
*
Like {@link ChannelOrderAction}, the returned {@link CategoryOrderAction CategoryOrderAction}
* can be used to move VoiceChannels/StageChannels {@link OrderAction#moveUp(int) up},
* {@link OrderAction#moveDown(int) down}, or
* {@link OrderAction#moveTo(int) to} a specific position.
*
This uses ascending order with a 0 based index.
*
* Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} include:
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_CHANNEL UNNKOWN_CHANNEL}
*
One of the channels has been deleted before the completion of the task.
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
*
The currently logged in account was removed from the Guild.
*
*
* @return A {@link CategoryOrderAction CategoryOrderAction} for
* ordering the Category's {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannels}
* and {@link net.dv8tion.jda.api.entities.StageChannel StageChannels}.
*/
@Nonnull
@CheckReturnValue
CategoryOrderAction modifyVoiceChannelPositions();
@Nonnull
@Override
default List getMembers()
{
return Collections.unmodifiableList(getChannels().stream()
.filter(IMemberContainer.class::isInstance)
.map(IMemberContainer.class::cast)
.map(IMemberContainer::getMembers)
.flatMap(List::stream)
.distinct()
.collect(Collectors.toList()));
}
@Nonnull
@Override
ChannelAction createCopy(@Nonnull Guild guild);
@Nonnull
@Override
ChannelAction createCopy();
@Nonnull
@Override
CategoryManager getManager();
}