discord4j.core.spec

Class WebhookCreateSpec

java.lang.Object

discord4j.core.spec.WebhookCreateSpec

All Implemented Interfaces:

AuditSpec<WebhookCreateRequest>, Spec<WebhookCreateRequest>

public class WebhookCreateSpec
extends Object
implements AuditSpec<WebhookCreateRequest>

Spec used to create a Webhook entity.

See Also:

Create Webhook

Constructor Summary

Constructors

Constructor and Description
WebhookCreateSpec()

Method Summary

Modifier and Type	Method and Description
WebhookCreateRequest	asRequest()
String	getReason() Returns the current audit log reason set on the spec.
WebhookCreateSpec	setAvatar(Image avatar) Sets the image of the created Webhook.
WebhookCreateSpec	setName(String name) Sets the name of the created Webhook.
WebhookCreateSpec	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

WebhookCreateSpec

public WebhookCreateSpec()

Method Detail

setName

public WebhookCreateSpec setName(String name)

Sets the name of the created Webhook.

Parameters:

name - The webhook name.

Returns:

This spec.

setAvatar

public WebhookCreateSpec setAvatar(@Nullable
                                   Image avatar)

Sets the image of the created Webhook.

Parameters:

avatar - The webhook image.

Returns:

This spec.

setReason

public WebhookCreateSpec setReason(@Nullable
                                   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<WebhookCreateRequest>

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<WebhookCreateRequest>

Returns:

The current audit log reason.

asRequest

public WebhookCreateRequest asRequest()

Specified by:

asRequest in interface Spec<WebhookCreateRequest>