Package net.dv8tion.jda.internal.entities

Class WebhookImpl

java.lang.Object

net.dv8tion.jda.internal.entities.AbstractWebhookClient<Message>

net.dv8tion.jda.internal.entities.WebhookImpl

All Implemented Interfaces:

ISnowflake, Webhook, WebhookClient<Message>

public class WebhookImpl
extends AbstractWebhookClient<Message>
implements Webhook

The implementation for Webhook

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Webhook

Webhook.ChannelReference, Webhook.GuildReference, Webhook.WebhookReference

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.Webhook

WEBHOOK_URL

Constructor Summary

Constructors

Constructor	Description
WebhookImpl(IWebhookContainer channel, long id, WebhookType type)
WebhookImpl(IWebhookContainer channel, JDA api, long id, WebhookType type)

Method Summary

Modifier and Type	Method	Description
AuditableRestAction<Void>	delete()	Deletes this Webhook.
AuditableRestAction<Void>	delete(String token)	Deletes this Webhook.
WebhookMessageDeleteAction	deleteMessageById(String messageId)	Delete a message from this webhook.
WebhookMessageEditActionImpl<Message>	editRequest(String messageId)
boolean	equals(Object obj)
IWebhookContainerUnion	getChannel()	The channel instance this Webhook is attached to.
User	getDefaultUser()	The default User for this Webhook.
Guild	getGuild()	The Guild instance for this Webhook.
JDA	getJDA()	The associated JDA instance.
WebhookManager	getManager()	The WebhookManager for this Webhook.
String	getName()	The name of this Webhook.
Member	getOwner()	The owner of this Webhook.
User	getOwnerAsUser()	The owner of this Webhook.
Webhook.ChannelReference	getSourceChannel()	The source channel for a Webhook of type FOLLOWER.
Webhook.GuildReference	getSourceGuild()	The source guild for a Webhook of type FOLLOWER.
WebhookType	getType()	The WebhookType of this webhook.
String	getUrl()	The POST route for this Webhook.
int	hashCode()
boolean	isPartial()	Whether this webhook cannot provide Webhook.getChannel() and Webhook.getGuild().
WebhookMessageRetrieveAction	retrieveMessageById(String messageId)	Retrieves the message with the provided id.
WebhookMessageCreateActionImpl<Message>	sendRequest()
WebhookImpl	setOwner(Member member, User user)
WebhookImpl	setSourceChannel(Webhook.ChannelReference reference)
WebhookImpl	setSourceGuild(Webhook.GuildReference reference)
WebhookImpl	setToken(String token)
WebhookImpl	setUser(User user)
String	toString()

Methods inherited from class net.dv8tion.jda.internal.entities.AbstractWebhookClient

editMessageAttachmentsById, editMessageById, editMessageById, editMessageComponentsById, editMessageEmbedsById, getIdLong, getToken, sendFiles, sendMessage, sendMessage, sendMessageComponents, sendMessageEmbeds, sendMessagePoll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getId, getIdLong, getTimeCreated

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

getToken

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

deleteMessageById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageById, editMessageById, editMessageById, editMessageById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageFormatById, editMessageFormatById, sendFiles, sendFiles, sendMessage, sendMessage, sendMessageComponents, sendMessageComponents, sendMessageComponents, sendMessageEmbeds, sendMessageEmbeds, sendMessageFormat, sendMessagePoll

Constructor Details

WebhookImpl

public WebhookImpl(IWebhookContainer channel,
 long id,
 WebhookType type)

WebhookImpl

public WebhookImpl(IWebhookContainer channel,
 JDA api,
 long id,
 WebhookType type)

Method Details

getType

@Nonnull
public WebhookType getType()

Description copied from interface: Webhook

The WebhookType of this webhook.
Webhooks of type WebhookType.FOLLOWER don't have a token.

Specified by:

getType in interface Webhook

Returns:

The WebhookType

isPartial

public boolean isPartial()

Description copied from interface: Webhook

Whether this webhook cannot provide Webhook.getChannel() and Webhook.getGuild().
This means that the webhook is not local to this shard's cache and cannot provide full channel/guild references.

Specified by:

isPartial in interface Webhook

Returns:

True, if Webhook.getChannel() and Webhook.getGuild() would throw

getJDA

@Nonnull
public JDA getJDA()

Description copied from interface: WebhookClient

The associated JDA instance.

Specified by:

getJDA in interface Webhook

Specified by:

getJDA in interface WebhookClient<Message>

Overrides:

getJDA in class AbstractWebhookClient<Message>

Returns:

The JDA instance

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: Webhook

The Guild instance for this Webhook.
This is a shortcut for Webhook.getChannel().getGuild().

Specified by:

getGuild in interface Webhook

Returns:

The current Guild of this Webhook

getChannel

@Nonnull
public IWebhookContainerUnion getChannel()

Description copied from interface: Webhook

The channel instance this Webhook is attached to. Webhooks are created on specific channels so that they can interact with that channel. With regard to threads, Webhooks are attached to their parent channel and then the Webhooks can post to the parent and the thread too.

Specified by:

getChannel in interface Webhook

Returns:

The current channel that this webhook is attached to.

getOwner

public Member getOwner()

Description copied from interface: Webhook

The owner of this Webhook. This will be null for some Webhooks, such as those retrieved from Audit Logs.
This requires the member to be cached. You can use Webhook.getOwnerAsUser() to get a reference to the user instead.

Specified by:

getOwner in interface Webhook

Returns:

Possibly-null Member instance representing the owner of this Webhook.

getOwnerAsUser

public User getOwnerAsUser()

Description copied from interface: Webhook

The owner of this Webhook. This will be null for some Webhooks, such as those retrieved from Audit Logs.
This can be non-null even when Webhook.getOwner() is null. Webhook.getOwner() requires the webhook to be local to this shard and in cache.

Specified by:

getOwnerAsUser in interface Webhook

Returns:

Possibly-null User instance representing the owner of this Webhook.

getDefaultUser

@Nonnull
public User getDefaultUser()

Description copied from interface: Webhook

The default User for this Webhook.

The User returned is always fake and cannot be interacted with.
This User is used for all messages posted to the Webhook route (found in Webhook.getUrl()), it holds the default references for the message authors of messages by this Webhook.

When POSTing to a Webhook route the name/avatar of this default user can be overridden.

Specified by:

getDefaultUser in interface Webhook

Returns:

A fake User instance representing the default webhook user.

See Also:

• Execute Webhook Docs

getName

@Nonnull
public String getName()

Description copied from interface: Webhook

The name of this Webhook.
This will be displayed by default as the author name of every message by this Webhook.

This is a shortcut for Webhook.getDefaultUser().getName().

Specified by:

getName in interface Webhook

Returns:

The name of this Webhook

getUrl

@Nonnull
public String getUrl()

Description copied from interface: Webhook

The POST route for this Webhook.
This contains the token and id of this Webhook. Some Webhooks without tokens (such as those retrieved from Audit Logs) will return a URL without a token.

The route returned by this method does not need permission checks to be executed.
It is implied that Webhook messages always have all permissions including mentioning everyone.

Webhook executions are limited with 5 requests per second. The response contains rate limit headers that should be handled by execution frameworks. (Learn More)

Specified by:

getUrl in interface Webhook

Returns:

The execution route for this Webhook.

getSourceChannel

public Webhook.ChannelReference getSourceChannel()

Description copied from interface: Webhook

The source channel for a Webhook of type FOLLOWER.

Specified by:

getSourceChannel in interface Webhook

Returns:

Webhook.ChannelReference

getSourceGuild

public Webhook.GuildReference getSourceGuild()

Description copied from interface: Webhook

The source guild for a Webhook of type FOLLOWER.

Specified by:

getSourceGuild in interface Webhook

Returns:

Webhook.GuildReference

delete

@Nonnull
public AuditableRestAction<Void> delete()

Description copied from interface: Webhook

Deletes this Webhook.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The delete was attempted after the account lost permission to view the channel.
• MISSING_PERMISSIONS
  The delete was attempted after the account lost Permission.MANAGE_WEBHOOKS in the channel.
• UNKNOWN_WEBHOOK
  The delete was attempted after the Webhook had already been deleted.

Specified by:

delete in interface Webhook

Returns:

AuditableRestAction
The rest action to delete this Webhook.

delete

@Nonnull
public AuditableRestAction<Void> delete(@Nonnull
 String token)

Description copied from interface: Webhook

Deletes this Webhook.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The delete was attempted after the account lost permission to view the channel.
• MISSING_PERMISSIONS
  The delete was attempted after the account lost Permission.MANAGE_WEBHOOKS in the channel.
• UNKNOWN_WEBHOOK
  The delete was attempted after the Webhook had already been deleted.
• INVALID_WEBHOOK_TOKEN
  If the provided webhook token is not valid.

Specified by:

delete in interface Webhook

Parameters:

token - The webhook token (this is not the bot authorization token!)

Returns:

AuditableRestAction
The rest action to delete this Webhook.

getManager

@Nonnull
public WebhookManager getManager()

Description copied from interface: Webhook

The WebhookManager for this Webhook.
You can modify multiple fields in one request by chaining setters before calling RestAction.queue().

Specified by:

getManager in interface Webhook

Returns:

The WebhookManager for this Webhook

sendRequest

public WebhookMessageCreateActionImpl<Message> sendRequest()

Specified by:

sendRequest in class AbstractWebhookClient<Message>

editRequest

public WebhookMessageEditActionImpl<Message> editRequest(String messageId)

Specified by:

editRequest in class AbstractWebhookClient<Message>

deleteMessageById

@Nonnull
public WebhookMessageDeleteAction deleteMessageById(@Nonnull
 String messageId)

Description copied from interface: WebhookClient

Delete a message from this webhook.

Use setThreadId(threadId) to delete messages from threads.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist

Specified by:

deleteMessageById in interface WebhookClient<Message>

Overrides:

deleteMessageById in class AbstractWebhookClient<Message>

Parameters:

messageId - The id for the message to delete

Returns:

WebhookMessageDeleteAction

retrieveMessageById

@Nonnull
public WebhookMessageRetrieveAction retrieveMessageById(@Nonnull
 String messageId)

Description copied from interface: WebhookClient

Retrieves the message with the provided id.
This only works for messages sent by this webhook. All other messages are unknown.

Use setThreadId(threadId) to retrieve messages from threads.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  If the message is inaccessible to this webhook or does not exist.

Specified by:

retrieveMessageById in interface WebhookClient<Message>

Returns:

WebhookMessageRetrieveAction

setOwner

public WebhookImpl setOwner(Member member,
 User user)

setToken

public WebhookImpl setToken(String token)

setUser

public WebhookImpl setUser(User user)

setSourceGuild

public WebhookImpl setSourceGuild(Webhook.GuildReference reference)

setSourceChannel

public WebhookImpl setSourceChannel(Webhook.ChannelReference reference)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object