discord4j.core.spec

Interface AuditSpec<T>

All Superinterfaces:

Spec<T>

All Known Implementing Classes:

BanQuerySpec, CategoryCreateSpec, CategoryEditSpec, GuildEditSpec, GuildEmojiCreateSpec, GuildEmojiEditSpec, GuildMemberEditSpec, GuildPruneSpec, InviteCreateSpec, NewsChannelCreateSpec, NewsChannelEditSpec, RoleCreateSpec, RoleEditSpec, StoreChannelEditSpec, TextChannelCreateSpec, TextChannelEditSpec, VoiceChannelCreateSpec, VoiceChannelEditSpec, WebhookCreateSpec, WebhookEditSpec

public interface AuditSpec<T>
extends Spec<T>

A spec which can optionally have a reason in the audit logs when built.

Method Summary

Modifier and Type	Method and Description
String	getReason() Returns the current audit log reason set on the spec.
AuditSpec<T>	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.

Methods inherited from interface discord4j.core.spec.Spec

asRequest

Method Detail

setReason

AuditSpec<T> setReason(@Nullable
                       String reason)

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

Parameters:

reason - The audit log reason.

Returns:

This spec.

getReason

@Nullable
String getReason()

Returns the current audit log reason set on the spec.

Returns:

The current audit log reason.