net.dv8tion.jda.api.managers.channel.ChannelManager 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.managers.channel;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.channel.Channel;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.managers.Manager;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
/**
* Manager providing functionality to update one or more fields for a {@link GuildChannel GuildChannel}.
*
* Example
*
{@code
* manager.setName("github-log")
* .setTopic("logs for github commits")
* .setNSFW(false)
* .queue();
* manager.reset(ChannelManager.PARENT | ChannelManager.NAME)
* .setName("nsfw-commits")
* .queue();
* manager.setTopic("Java is to Javascript as wall is to wallet")
* .queue();
* }
*
* @see GuildChannel#getManager()
*/
public interface ChannelManager> extends Manager
{
/** Used to reset the name field */
long NAME = 1;
/** Used to reset the parent field */
long PARENT = 1 << 1;
/** Used to reset the topic field */
long TOPIC = 1 << 2;
/** Used to reset the position field */
long POSITION = 1 << 3;
/** Used to reset the nsfw field */
long NSFW = 1 << 4;
/** Used to reset the userlimit field */
long USERLIMIT = 1 << 5;
/** Used to reset the bitrate field */
long BITRATE = 1 << 6;
/** Used to reset the permission field */
long PERMISSION = 1 << 7;
/** Used to reset the rate-limit per user field */
long SLOWMODE = 1 << 8;
/** Used to reset the channel type field */
long TYPE = 1 << 9;
/** Used to reset the region field */
long REGION = 1 << 10;
/** Used to reset the auto-archive-duration field */
long AUTO_ARCHIVE_DURATION = 1 << 11;
/** Used to reset the archived field */
long ARCHIVED = 1 << 12;
/** Used to reset the locked field */
long LOCKED = 1 << 13;
/** Used to reset the invitable field */
long INVITEABLE = 1 << 14;
/** Used to reset the available tags field */
long AVAILABLE_TAGS = 1 << 15;
/** Used to reset the applied tags field */
long APPLIED_TAGS = 1 << 16;
/** Used to reset the pinned state field */
long PINNED = 1 << 17;
/** Used to reset the require tag state field */
long REQUIRE_TAG = 1 << 18;
/** Used to reset the default reaction emoji field */
long DEFAULT_REACTION = 1 << 19;
/** Used to reset the default layout field */
long DEFAULT_LAYOUT = 1 << 20;
/** Used to reset the default sort order field */
long DEFAULT_SORT_ORDER = 1 << 21;
/** Used to reset the hide media download option flag */
long HIDE_MEDIA_DOWNLOAD_OPTIONS = 1 << 22;
/** Used to reset the default thread slowmode of a thread container */
long DEFAULT_THREAD_SLOWMODE = 1 << 23;
/**
* Resets the fields specified by the provided bit-flag pattern.
* You can specify a combination by using a bitwise OR concat of the flag constants.
*
Example: {@code manager.reset(ChannelManager.NAME | ChannelManager.PARENT);}
*
* Flag Constants:
*
* - {@link #NAME}
* - {@link #PARENT}
* - {@link #TOPIC}
* - {@link #POSITION}
* - {@link #NSFW}
* - {@link #SLOWMODE}
* - {@link #USERLIMIT}
* - {@link #BITRATE}
* - {@link #PERMISSION}
* - {@link #TYPE}
* - {@link #REGION}
* - {@link #AUTO_ARCHIVE_DURATION}
* - {@link #ARCHIVED}
* - {@link #LOCKED}
* - {@link #INVITEABLE}
* - {@link #AVAILABLE_TAGS}
* - {@link #APPLIED_TAGS}
* - {@link #PINNED}
* - {@link #REQUIRE_TAG}
* - {@link #DEFAULT_REACTION}
* - {@link #DEFAULT_LAYOUT}
* - {@link #DEFAULT_SORT_ORDER}
* - {@link #HIDE_MEDIA_DOWNLOAD_OPTIONS}
* - {@link #DEFAULT_THREAD_SLOWMODE}
*
*
* @param fields
* Integer value containing the flags to reset.
*
* @return ChannelManager for chaining convenience
*/
@Nonnull
@Override
M reset(long fields);
/**
* Resets the fields specified by the provided bit-flag patterns.
*
Example: {@code manager.reset(ChannelManager.NAME, ChannelManager.PARENT);}
*
* Flag Constants:
*
* - {@link #NAME}
* - {@link #PARENT}
* - {@link #TOPIC}
* - {@link #POSITION}
* - {@link #NSFW}
* - {@link #USERLIMIT}
* - {@link #BITRATE}
* - {@link #PERMISSION}
* - {@link #TYPE}
* - {@link #REGION}
* - {@link #AUTO_ARCHIVE_DURATION}
* - {@link #ARCHIVED}
* - {@link #LOCKED}
* - {@link #INVITEABLE}
* - {@link #AVAILABLE_TAGS}
* - {@link #APPLIED_TAGS}
* - {@link #PINNED}
* - {@link #REQUIRE_TAG}
* - {@link #DEFAULT_REACTION}
* - {@link #DEFAULT_LAYOUT}
* - {@link #DEFAULT_SORT_ORDER}
* - {@link #HIDE_MEDIA_DOWNLOAD_OPTIONS}
* - {@link #DEFAULT_THREAD_SLOWMODE}
*
*
* @param fields
* Integer values containing the flags to reset.
*
* @return ChannelManager for chaining convenience
*/
@Nonnull
@Override
M reset(long... fields);
/**
* The {@link GuildChannel GuildChannel} that will
* be modified by this Manager instance
*
* @return The {@link GuildChannel GuildChannel}
*/
@Nonnull
T getChannel();
/**
* The {@link Guild Guild} this Manager's
* {@link GuildChannel GuildChannel} is in.
*
This is logically the same as calling {@code getChannel().getGuild()}
*
* @return The parent {@link Guild Guild}
*/
@Nonnull
default Guild getGuild()
{
return getChannel().getGuild();
}
/**
* Sets the name of the selected {@link GuildChannel GuildChannel}.
*
* A channel name must not be {@code null} nor empty or more than {@value Channel#MAX_NAME_LENGTH} characters long!
*
TextChannel names may only be populated with alphanumeric (with underscore and dash).
*
*
Example: {@code mod-only} or {@code generic_name}
*
Characters will automatically be lowercased by Discord for text channels!
*
* @param name
* The new name for the selected {@link GuildChannel GuildChannel}
*
* @throws IllegalArgumentException
* If the provided name is {@code null} or not between 1-{@value Channel#MAX_NAME_LENGTH} characters long
*
* @return ChannelManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
M setName(@Nonnull String name);
}