discord4j.core.spec

Class GuildEditSpec

java.lang.Object

discord4j.core.spec.GuildEditSpec

All Implemented Interfaces:

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

public class GuildEditSpec
extends Object
implements AuditSpec<discord4j.discordjson.json.GuildModifyRequest>

A spec used to selectively modify properties from a Guild.

See Also:

Modify Guild

Constructor Summary

Constructors

Constructor and Description
GuildEditSpec()

Method Summary

Modifier and Type	Method and Description
discord4j.discordjson.json.GuildModifyRequest	asRequest()
String	getReason() Returns the current audit log reason set on the spec.
GuildEditSpec	setAfkChannelId(Snowflake afkChannelId) Sets the Snowflake identifier for the channel designated as AFK channel in this Guild.
GuildEditSpec	setAfkTimeout(int afkTimeout) Sets the AFK timeout, in seconds, for this Guild.
GuildEditSpec	setBanner(Image banner) Sets the banner image to display for the modified Guild.
GuildEditSpec	setDefaultMessageNotificationsLevel(Guild.NotificationLevel notificationsLevel) Sets the default message notification level for the modified Guild.
GuildEditSpec	setIcon(Image icon) Sets the image icon to display for the modified Guild.
GuildEditSpec	setName(String name) Sets the modified Guild name.
GuildEditSpec	setOwnerId(Snowflake ownerId) Sets the new owner ID for this Guild.
GuildEditSpec	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.
GuildEditSpec	setRegion(Region region) Sets the voice region for the modified Guild.
GuildEditSpec	setSplash(Image splash) Sets the splash image to display for the modified Guild.
GuildEditSpec	setVerificationLevel(Guild.VerificationLevel verificationLevel) Sets the verification level required before a member can send messages in the modified Guild.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuildEditSpec

public GuildEditSpec()

Method Detail

setName

public GuildEditSpec setName(String name)

Sets the modified Guild name.

Parameters:

name - the guild name

Returns:

this spec

setRegion

public GuildEditSpec setRegion(Region region)

Sets the voice region for the modified Guild.

Parameters:

region - The voice region for the guild.

Returns:

This spec.

setVerificationLevel

public GuildEditSpec setVerificationLevel(Guild.VerificationLevel verificationLevel)

Sets the verification level required before a member can send messages in the modified Guild.

Parameters:

verificationLevel - The verification level for the guild.

Returns:

This spec.

setDefaultMessageNotificationsLevel

public GuildEditSpec setDefaultMessageNotificationsLevel(Guild.NotificationLevel notificationsLevel)

Sets the default message notification level for the modified Guild.

Parameters:

notificationsLevel - The default notification level for the guild.

Returns:

This spec.

setAfkChannelId

public GuildEditSpec setAfkChannelId(@Nullable
                                     Snowflake afkChannelId)

Sets the Snowflake identifier for the channel designated as AFK channel in this Guild.

Parameters:

afkChannelId - The identifier for the AFK channel.

Returns:

This spec.

setAfkTimeout

public GuildEditSpec setAfkTimeout(int afkTimeout)

Sets the AFK timeout, in seconds, for this Guild.

Parameters:

afkTimeout - The AFK timeout, in seconds.

Returns:

This spec.

setIcon

public GuildEditSpec setIcon(@Nullable
                             Image icon)

Sets the image icon to display for the modified Guild.

Parameters:

icon - The icon for the guild.

Returns:

This spec.

setOwnerId

public GuildEditSpec setOwnerId(Snowflake ownerId)

Sets the new owner ID for this Guild. Used to transfer guild ownership if this client is the owner.

Parameters:

ownerId - The identifier for the new guild owner.

Returns:

This spec.

setSplash

public GuildEditSpec setSplash(@Nullable
                               Image splash)

Sets the splash image to display for the modified Guild. Used in VIP guilds.

Parameters:

splash - The image for the guild.

Returns:

This spec.

setBanner

public GuildEditSpec setBanner(@Nullable
                               Image banner)

Sets the banner image to display for the modified Guild. Used in VERIFIED guilds.

Parameters:

banner - The image for the guild.

Returns:

This spec.

setReason

public GuildEditSpec 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<discord4j.discordjson.json.GuildModifyRequest>

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.GuildModifyRequest>

Returns:

The current audit log reason.

asRequest

public discord4j.discordjson.json.GuildModifyRequest asRequest()

Specified by:

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