discord4j.core.spec

Class WebhookEditSpec

java.lang.Object

discord4j.core.spec.WebhookEditSpec

All Implemented Interfaces:

AuditSpec<discord4j.discordjson.json.WebhookModifyRequest>, Spec<discord4j.discordjson.json.WebhookModifyRequest>

public class WebhookEditSpec
extends Object
implements AuditSpec<discord4j.discordjson.json.WebhookModifyRequest>

Spec to modify a Webhook entity.

See Also:

Modify Webhook

Constructor Summary

Constructors

Constructor and Description
WebhookEditSpec()

Method Summary

Modifier and Type	Method and Description
discord4j.discordjson.json.WebhookModifyRequest	asRequest()
String	getReason() Returns the current audit log reason set on the spec.
WebhookEditSpec	setAvatar(Image avatar) Sets the image of the modified Webhook.
WebhookEditSpec	setChannel(Snowflake id) Sets the channel ID of the modified Webhook.
WebhookEditSpec	setName(String name) Sets the name of the modified Webhook.
WebhookEditSpec	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhookEditSpec

public WebhookEditSpec()

Method Detail

setName

public WebhookEditSpec setName(String name)

Sets the name of the modified Webhook.

Parameters:

name - The webhook name.

Returns:

This spec.

setAvatar

public WebhookEditSpec setAvatar(@Nullable
                                 Image avatar)

Sets the image of the modified Webhook.

Parameters:

avatar - The webhook image.

Returns:

This spec.

setChannel

public WebhookEditSpec setChannel(@Nullable
                                  Snowflake id)

Sets the channel ID of the modified Webhook.

Parameters:

id - the new channel id this webhook should be moved to

Returns:

This spec.

setReason

public WebhookEditSpec setReason(String reason)

Description copied from interface: AuditSpec

Sets the reason to show in the audit logs when the spec is built.

Specified by:

setReason in interface AuditSpec<discord4j.discordjson.json.WebhookModifyRequest>

Parameters:

reason - The audit log reason.

Returns:

This spec.

getReason

@Nullable
public String getReason()

Description copied from interface: AuditSpec

Returns the current audit log reason set on the spec.

Specified by:

getReason in interface AuditSpec<discord4j.discordjson.json.WebhookModifyRequest>

Returns:

The current audit log reason.

asRequest

public discord4j.discordjson.json.WebhookModifyRequest asRequest()

Specified by:

asRequest in interface Spec<discord4j.discordjson.json.WebhookModifyRequest>