Interface ICopyableChannel

All Superinterfaces:

Channel, Comparable<GuildChannel>, Formattable, GuildChannel, IDetachableEntity, IMentionable, ISnowflake

All Known Subinterfaces:

AudioChannel, AudioChannelUnion, Category, DefaultGuildChannelUnion, ForumChannel, MediaChannel, NewsChannel, StageChannel, StandardGuildChannel, StandardGuildMessageChannel, TextChannel, VoiceChannel

public interface ICopyableChannel
extends GuildChannel

Represents a GuildChannel that is capable of being copied.

Please see createCopy() for information on what is copied.

Field Summary

Fields inherited from interface Channel

MAX_NAME_LENGTH

Fields inherited from interface GuildChannel

JUMP_URL

Method Summary

Modifier and Type	Method	Description
ChannelAction<? extends ICopyableChannel>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<? extends ICopyableChannel>	createCopy(Guild guild)	Creates a copy of the specified GuildChannel in the specified Guild.

Methods inherited from interface Channel

formatTo, getAsMention, getFlags, getJDA, getName, getType

Methods inherited from interface Comparable

compareTo

Methods inherited from interface GuildChannel

delete, getGuild, getJumpUrl, getManager, getPermissionContainer

Methods inherited from interface IDetachableEntity

isDetached

Methods inherited from interface ISnowflake

getId, getIdLong, getTimeCreated

Method Details

createCopy

@Nonnull
@CheckReturnValue
ChannelAction<? extends ICopyableChannel> createCopy(@Nonnull
 Guild guild)

Creates a copy of the specified GuildChannel in the specified Guild.
If the provided target guild is not the same Guild this channel is in then the parent category and permissions will not be copied due to technical difficulty and ambiguity.

This copies the following elements:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Parameters:

guild - The Guild to create the channel in

Returns:

A specific ChannelAction
This action allows to set fields for the new GuildChannel before creating it!

Throws:

IllegalArgumentException - If the provided guild is null

PermissionException - If the currently logged in account does not have the MANAGE_CHANNEL Permission

DetachedEntityException - If the guild the channel should be copied to is detached

createCopy

@Nonnull
@CheckReturnValue
ChannelAction<? extends ICopyableChannel> createCopy()

Creates a copy of the specified GuildChannel.

This copies the following elements:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Returns:

A specific ChannelAction
This action allows to set fields for the new GuildChannel before creating it!

Throws:

PermissionException - If the currently logged in account does not have the MANAGE_CHANNEL Permission

DetachedEntityException - If this entity is detached