Package net.dv8tion.jda.api.entities.channel.attribute

Interface IWebhookContainer

All Superinterfaces:

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

All Known Subinterfaces:

ForumChannel, IWebhookContainerUnion, NewsChannel, StageChannel, StandardGuildMessageChannel, TextChannel, VoiceChannel

public interface IWebhookContainer
extends GuildChannel

Represents a GuildChannel that is capable of utilizing webhooks. Webhooks can be used to integrate third-party systems into Discord by way of sending information via messages.

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.channel.Channel

MAX_NAME_LENGTH

Fields inherited from interface net.dv8tion.jda.api.entities.channel.middleman.GuildChannel

JUMP_URL

Method Summary

Modifier and Type	Method	Description
WebhookAction	createWebhook(String name)	Creates a new Webhook.
AuditableRestAction<Void>	deleteWebhookById(String id)	Deletes a Webhook attached to this channel by the id specified.
RestAction<List<Webhook>>	retrieveWebhooks()	Retrieves the Webhooks attached to this channel.

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

formatTo, getAsMention, getFlags, getJDA, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

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

delete, getGuild, getJumpUrl, getManager, getPermissionContainer

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

getId, getIdLong, getTimeCreated

Method Details

retrieveWebhooks

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

Retrieves the Webhooks attached to this channel.

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 channel, 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.