Package net.dv8tion.jda.api.entities

Interface NewsChannel

All Superinterfaces:

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

public interface NewsChannel
extends BaseGuildMessageChannel

Represents BaseGuildMessageChannel that are News Channels. The Discord client may refer to these as Announcement Channels. Members can subscribe channels in their own guilds to receive messages crossposted from this channel. This is referred to as following this channel. Messages sent in this channel can be crossposted, at which point they will be sent (via webhook) to all subscribed channels.

See Also:

• Message.getFlags()
• Message.MessageFlag.CROSSPOSTED

Method Summary

Modifier and Type	Method	Description
default ChannelAction<NewsChannel>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<NewsChannel>	createCopy(Guild guild)	Creates a copy of the specified GuildChannel in the specified Guild.
default RestAction<Message>	crosspostMessageById(long messageId)	Attempts to crosspost the provided message.
default RestAction<Message>	crosspostMessageById(String messageId)	Attempts to crosspost the provided message.
default RestAction<Webhook.WebhookReference>	follow(long targetChannelId)	Subscribes to the crossposted messages in this channel.
RestAction<Webhook.WebhookReference>	follow(String targetChannelId)	Subscribes to the crossposted messages in this channel.
default RestAction<Webhook.WebhookReference>	follow(TextChannel targetChannel)	Subscribes to the crossposted messages in this channel.
NewsChannelManager	getManager()	Returns the ChannelManager for this GuildChannel.

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

createWebhook, deleteWebhookById, getTopic, isNSFW, retrieveWebhooks

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 Details

follow

@Nonnull
@CheckReturnValue
RestAction<Webhook.WebhookReference> follow(@Nonnull
 String targetChannelId)

Subscribes to the crossposted messages in this channel.
This will create a Webhook of type FOLLOWER in the target channel.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  If the target channel doesn't exist or is not visible to the currently logged in account
• MISSING_PERMISSIONS
  If the currently logged in account does not have Permission.MANAGE_WEBHOOKS in the target channel
• MAX_WEBHOOKS
  If the target channel already has reached the maximum capacity for webhooks

Parameters:

targetChannelId - The target channel id

Returns:

RestAction

Throws:

IllegalArgumentException - If null is provided

Since:

4.2.1

follow

@Nonnull
@CheckReturnValue
default RestAction<Webhook.WebhookReference> follow(long targetChannelId)

Subscribes to the crossposted messages in this channel.
This will create a Webhook of type FOLLOWER in the target channel.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  If the target channel doesn't exist or not visible to the currently logged in account
• MISSING_PERMISSIONS
  If the currently logged in account does not have Permission.MANAGE_WEBHOOKS in the target channel
• MAX_WEBHOOKS
  If the target channel already has reached the maximum capacity for webhooks

Parameters:

targetChannelId - The target channel id

Returns:

RestAction

Since:

4.2.1

follow

@Nonnull
@CheckReturnValue
default RestAction<Webhook.WebhookReference> follow(@Nonnull
 TextChannel targetChannel)

Subscribes to the crossposted messages in this channel.
This will create a Webhook of type FOLLOWER in the target channel.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  If the target channel doesn't exist or not visible to the currently logged in account
• MISSING_PERMISSIONS
  If the currently logged in account does not have Permission.MANAGE_WEBHOOKS in the target channel
• MAX_WEBHOOKS
  If the target channel already has reached the maximum capacity for webhooks

Parameters:

targetChannel - The target channel

Returns:

RestAction

Throws:

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

IllegalArgumentException - If null is provided

Since:

4.2.1

crosspostMessageById

@Nonnull
@CheckReturnValue
default RestAction<Message> crosspostMessageById(@Nonnull
 String messageId)

Attempts to crosspost the provided message.

The following ErrorResponses are possible:

• ALREADY_CROSSPOSTED
  The target message has already been crossposted.
• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the TextChannel
• MISSING_PERMISSIONS
  The request was attempted after the account lost Permission.MESSAGE_MANAGE in the TextChannel.
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.

Parameters:

messageId - The messageId to crosspost

Returns:

RestAction - Type: Message

Throws:

IllegalArgumentException - If provided messageId is null or empty.

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

Since:

4.2.1

crosspostMessageById

@Nonnull
@CheckReturnValue
default RestAction<Message> crosspostMessageById(long messageId)

Attempts to crosspost the provided message.

The following ErrorResponses are possible:

• ALREADY_CROSSPOSTED
  The target message has already been crossposted.
• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the TextChannel
• MISSING_PERMISSIONS
  The request was attempted after the account lost Permission.MESSAGE_MANAGE in the TextChannel.
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.

Parameters:

messageId - The messageId to crosspost

Returns:

RestAction - Type: Message

Throws:

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

Since:

4.2.1

createCopy

@Nonnull
ChannelAction<NewsChannel> 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 BaseGuildMessageChannel

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
default ChannelAction<NewsChannel> 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 BaseGuildMessageChannel

Specified by:

createCopy in interface ICopyableChannel

Returns:

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

getManager

@Nonnull
NewsChannelManager 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 BaseGuildMessageChannel

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