Package discord4j.core.spec.legacy

Class LegacyBanQuerySpec

java.lang.Object

discord4j.core.spec.legacy.LegacyBanQuerySpec

All Implemented Interfaces:

LegacyAuditSpec<Map<String,Object>>, LegacySpec<Map<String,Object>>

public final class LegacyBanQuerySpec
extends Object
implements LegacyAuditSpec<Map<String,Object>>

A spec used to configure a user ban.

Constructor Summary

Constructors

Constructor	Description
LegacyBanQuerySpec()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asRequest()
String	getReason()	Returns the current audit log reason set on the spec.
LegacyBanQuerySpec	setDeleteMessageDays(int days)	Sets the number of days to delete messages for (0-7).
LegacyBanQuerySpec	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 Details

LegacyBanQuerySpec

public LegacyBanQuerySpec()

Method Details

setDeleteMessageDays

public LegacyBanQuerySpec setDeleteMessageDays(int days)

Sets the number of days to delete messages for (0-7).

Parameters:

days - A number from 0 to 7 indicating how many days of messages should be deleted when a user is banned.

Returns:

This spec.

setReason

public LegacyBanQuerySpec setReason(@Nullable
 String reason)

Description copied from interface: LegacyAuditSpec

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

Specified by:

setReason in interface LegacyAuditSpec<Map<String,Object>>

Parameters:

reason - The audit log reason.

Returns:

This spec.

getReason

@Nullable
public String getReason()

Description copied from interface: LegacyAuditSpec

Returns the current audit log reason set on the spec.

Specified by:

getReason in interface LegacyAuditSpec<Map<String,Object>>

Returns:

The current audit log reason.

asRequest

public Map<String,Object> asRequest()

Specified by:

asRequest in interface LegacySpec<Map<String,Object>>