Package net.dv8tion.jda.api.entities

Interface BaseGuildMessageChannel

All Superinterfaces:

Channel, Comparable<GuildChannel>, Formattable, GuildChannel, GuildMessageChannel, ICategorizableChannel, ICopyableChannel, IInviteContainer, IMemberContainer, IMentionable, IPermissionContainer, IPositionableChannel, ISnowflake, IThreadContainer, MessageChannel

All Known Subinterfaces:

NewsChannel, TextChannel

public interface BaseGuildMessageChannel
extends GuildMessageChannel, IThreadContainer, GuildChannel, ICategorizableChannel, ICopyableChannel, IPermissionContainer, IMemberContainer, IInviteContainer, IPositionableChannel

Method Summary

Modifier and Type	Method	Description
ChannelAction<? extends BaseGuildMessageChannel>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<? extends BaseGuildMessageChannel>	createCopy(Guild guild)	Creates a copy of the specified GuildChannel in the specified Guild.
WebhookAction	createWebhook(String name)	Creates a new Webhook.
AuditableRestAction<Void>	deleteWebhookById(String id)	Deletes a Webhook attached to this channel by the id specified.
BaseGuildMessageChannelManager<?,?>	getManager()	Returns the ChannelManager for this GuildChannel.
String	getTopic()	The topic set for this TextChannel.
boolean	isNSFW()	Whether or not this channel is considered as "NSFW" (Not-Safe-For-Work)
RestAction<List<Webhook>>	retrieveWebhooks()	Retrieves the Webhooks attached to this TextChannel.

Methods inherited from interface net.dv8tion.jda.api.entities.Channel

formatTo, getAsMention, getJDA, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface net.dv8tion.jda.api.entities.GuildChannel

delete, getGuild, getPermissionContainer

Methods inherited from interface net.dv8tion.jda.api.entities.GuildMessageChannel

canTalk, canTalk, clearReactionsById, clearReactionsById, clearReactionsById, clearReactionsById, clearReactionsById, clearReactionsById, deleteMessages, deleteMessagesByIds, removeReactionById, removeReactionById, removeReactionById, removeReactionById

Methods inherited from interface net.dv8tion.jda.api.entities.ICategorizableChannel

getParentCategory, getParentCategoryId, getParentCategoryIdLong, isSynced

Methods inherited from interface net.dv8tion.jda.api.entities.IInviteContainer

createInvite, retrieveInvites

Methods inherited from interface net.dv8tion.jda.api.entities.IMemberContainer

getMembers

Methods inherited from interface net.dv8tion.jda.api.entities.IPermissionContainer

createPermissionOverride, getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, putPermissionOverride, upsertPermissionOverride

Methods inherited from interface net.dv8tion.jda.api.entities.IPositionableChannel

getPosition, getPositionRaw

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.entities.IThreadContainer

createThreadChannel, createThreadChannel, createThreadChannel, createThreadChannel, getThreadChannels, retrieveArchivedPrivateJoinedThreadChannels, retrieveArchivedPrivateThreadChannels, retrieveArchivedPublicThreadChannels

Methods inherited from interface net.dv8tion.jda.api.entities.MessageChannel

addReactionById, addReactionById, addReactionById, addReactionById, deleteMessageById, deleteMessageById, editMessageById, editMessageById, editMessageById, editMessageById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageFormatById, editMessageFormatById, getHistory, getHistoryAfter, getHistoryAfter, getHistoryAfter, getHistoryAround, getHistoryAround, getHistoryAround, getHistoryBefore, getHistoryBefore, getHistoryBefore, getHistoryFromBeginning, getIterableHistory, getLatestMessageId, getLatestMessageIdLong, hasLatestMessage, pinMessageById, pinMessageById, purgeMessages, purgeMessages, purgeMessagesById, purgeMessagesById, purgeMessagesById, removeReactionById, removeReactionById, removeReactionById, removeReactionById, retrieveMessageById, retrieveMessageById, retrievePinnedMessages, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, sendFile, sendFile, sendFile, sendFile, sendMessage, sendMessage, sendMessageEmbeds, sendMessageEmbeds, sendMessageFormat, sendTyping, unpinMessageById, unpinMessageById

Method Detail

getManager

@Nonnull
BaseGuildMessageChannelManager<?,?> getManager()

Description copied from interface: GuildChannel

Returns the ChannelManager for this GuildChannel.
In the ChannelManager, you can modify the name, topic and position of this GuildChannel. You modify multiple fields in one request by chaining setters before calling RestAction.queue().

This is a lazy idempotent getter. The manager is retained after the first call. This getter is not thread-safe and would require guards by the user.

Specified by:

getManager in interface GuildChannel

Specified by:

getManager in interface ICategorizableChannel

Specified by:

getManager in interface IPermissionContainer

Specified by:

getManager in interface IPositionableChannel

Returns:

The ChannelManager of this GuildChannel

getTopic

@Nullable
String getTopic()

The topic set for this TextChannel.
If no topic has been set, this returns null.

Returns:

Possibly-null String containing the topic of this TextChannel.

isNSFW

boolean isNSFW()

Whether or not this channel is considered as "NSFW" (Not-Safe-For-Work)

Returns:

True, If this TextChannel is considered NSFW by the official Discord Client

retrieveWebhooks

@Nonnull
@CheckReturnValue
RestAction<List<Webhook>> retrieveWebhooks()

Retrieves the Webhooks attached to this TextChannel.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  if this channel was deleted
• MISSING_ACCESS
  if we were removed from the guild

Returns:

RestAction - Type: List<Webhook>
Retrieved an immutable list of Webhooks attached to this channel

createWebhook

@Nonnull
@CheckReturnValue
WebhookAction createWebhook(@Nonnull
                            String name)

Creates a new Webhook.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The webhook could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed
• MAX_WEBHOOKS
  If the channel already has reached the maximum capacity for webhooks

Parameters:

name - The default name for the new Webhook.

Returns:

A specific WebhookAction
This action allows to set fields for the new webhook before creating it

Throws:

PermissionException - If you do not hold the permission Manage Webhooks

IllegalArgumentException - If the provided name is null, blank or not between 2-100 characters in length

deleteWebhookById

@Nonnull
@CheckReturnValue
AuditableRestAction<Void> deleteWebhookById(@Nonnull
                                            String id)

Deletes a Webhook attached to this channel by the id specified.

Possible ErrorResponses include:

• ErrorResponse.UNKNOWN_WEBHOOK
  The provided id does not refer to a WebHook present in this TextChannel, either due to it not existing or having already been deleted.
• UNKNOWN_CHANNEL
  if this channel was deleted
• MISSING_ACCESS
  if we were removed from the guild
• MISSING_PERMISSIONS
  The send request was attempted after the account lost Permission.MANAGE_WEBHOOKS in the channel.

Parameters:

id - The not-null id for the target Webhook.

Returns:

AuditableRestAction

Throws:

IllegalArgumentException - If the provided id is null or empty.

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_WEBHOOKS in this channel.

createCopy

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

Description copied from interface: ICopyableChannel

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

Specified by:

createCopy in interface ICopyableChannel

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!

createCopy

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

Description copied from interface: ICopyableChannel

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

Specified by:

createCopy in interface ICopyableChannel

Returns:

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