discord4j.core.spec

Class BanQuerySpec

java.lang.Object

discord4j.core.spec.BanQuerySpec

All Implemented Interfaces:

AuditSpec<Map<String,Object>>, Spec<Map<String,Object>>

public final class BanQuerySpec
extends Object
implements AuditSpec<Map<String,Object>>

A spec used to configure a user ban.

Constructor Summary

Constructors

Constructor and Description
BanQuerySpec()

Method Summary

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

BanQuerySpec

public BanQuerySpec()

Method Detail

setDeleteMessageDays

public BanQuerySpec 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 BanQuerySpec 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<Map<String,Object>>

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<Map<String,Object>>

Returns:

The current audit log reason.

asRequest

public Map<String,Object> asRequest()

Specified by:

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