Package discord4j.core.spec

Class GuildCreateSpec

java.lang.Object

discord4j.core.spec.GuildCreateSpec

All Implemented Interfaces:

Spec<discord4j.discordjson.json.GuildCreateRequest>

public class GuildCreateSpec
extends Object
implements Spec<discord4j.discordjson.json.GuildCreateRequest>

A spec used to configure and create a Guild. This can only be used for bots in less than 10 guilds.

This spec also has some limitations to it. - The first role added, either from addEveryoneRole(java.util.function.Consumer<? super discord4j.core.spec.RoleCreateSpec>) or addRole(java.util.function.Consumer<? super discord4j.core.spec.RoleCreateSpec>), will automatically be set as the default @everyone role. Each subsequent call to addEveryoneRole(java.util.function.Consumer<? super discord4j.core.spec.RoleCreateSpec>) will not override the first role but shift all other roles down. - When using the channels parameter, the position field is ignored, and none of the default channels are created.

See Also:

Create Guild

Constructor Summary

Constructors

Constructor	Description
GuildCreateSpec()

Method Summary

Modifier and Type	Method	Description
GuildCreateSpec	addChannel(String name, Channel.Type type)	Adds the channel to the list of channels for the created Guild.
GuildCreateSpec	addEveryoneRole(Consumer<? super RoleCreateSpec> roleSpec)	Sets the default @everyone role for the created Guild.
GuildCreateSpec	addRole(Consumer<? super RoleCreateSpec> roleSpec)	Adds the role spec to the list of roles for the created Guild.
discord4j.discordjson.json.GuildCreateRequest	asRequest()
GuildCreateSpec	setAfkChannelId(Snowflake id)	Sets the ID of the AFK channel for the created Guild.
GuildCreateSpec	setAfkTimeout(Integer afkTimeout)	Sets the AFK timeout, in seconds, for the created Guild.
GuildCreateSpec	setDefaultMessageNotificationLevel(Guild.NotificationLevel notificationLevel)	Sets the default message notification level for the created Guild.
GuildCreateSpec	setExplicitContentFilter(Guild.ContentFilterLevel explicitContentFilter)	Sets the explicit content filter level for the created Guild.
GuildCreateSpec	setIcon(Image icon)	Sets the image icon to display for the created Guild.
GuildCreateSpec	setName(String name)	Sets the name for the created Guild.
GuildCreateSpec	setRegion(Region.Id regionId)	Sets the voice region id for the created Guild.
GuildCreateSpec	setRegion(String regionId)	Sets the voice region id for the created Guild, automatic if null.
GuildCreateSpec	setSystemChannelFlags(Guild.SystemChannelFlag... flags)	Sets the system channel flags for the created Guild.
GuildCreateSpec	setSystemChannelId(Snowflake id)	Sets the id of the channel where guild notices such as welcome messages and boost events are posted for the created Guild.
GuildCreateSpec	setVerificationLevel(Guild.VerificationLevel verificationLevel)	Sets the verification level required before a member can send messages in the created Guild.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuildCreateSpec

public GuildCreateSpec()

Method Detail

setName

public GuildCreateSpec setName(String name)

Sets the name for the created Guild.

Parameters:

name - The name of the guild.

Returns:

This spec.

setRegion

public GuildCreateSpec setRegion(Region.Id regionId)

Sets the voice region id for the created Guild.

Parameters:

regionId - The voice region id for the guild.

Returns:

This spec.

setRegion

public GuildCreateSpec setRegion(@Nullable
                                 String regionId)

Sets the voice region id for the created Guild, automatic if null.

Parameters:

regionId - The voice region id for the guild, automatic if null.

Returns:

This spec.

setIcon

public GuildCreateSpec setIcon(@Nullable
                               Image icon)

Sets the image icon to display for the created Guild.

Parameters:

icon - The icon for the guild.

Returns:

This spec.

setVerificationLevel

public GuildCreateSpec setVerificationLevel(@Nullable
                                            Guild.VerificationLevel verificationLevel)

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

Parameters:

verificationLevel - The verification level for the guild.

Returns:

This spec.

setDefaultMessageNotificationLevel

public GuildCreateSpec setDefaultMessageNotificationLevel(@Nullable
                                                          Guild.NotificationLevel notificationLevel)

Sets the default message notification level for the created Guild.

Parameters:

notificationLevel - The default notification level for the guild.

Returns:

This spec.

setExplicitContentFilter

public GuildCreateSpec setExplicitContentFilter(@Nullable
                                                Guild.ContentFilterLevel explicitContentFilter)

Sets the explicit content filter level for the created Guild.

Parameters:

explicitContentFilter - The explicit content filter level for the guild.

Returns:

This spec.

addRole

public GuildCreateSpec addRole(Consumer<? super RoleCreateSpec> roleSpec)

Adds the role spec to the list of roles for the created Guild.

Parameters:

roleSpec - The role spec to add to the list of roles.

Returns:

This spec.

addEveryoneRole

public GuildCreateSpec addEveryoneRole(Consumer<? super RoleCreateSpec> roleSpec)

Sets the default @everyone role for the created Guild. This shifts all other roles in the list, if present, down by one. It does not replace other @everyone roles already set.

When creating a guild, Discord automatically takes the first role in the role array as the default @everyone role. See this limitation and others at GuildCreateSpec.

Parameters:

roleSpec - The default @everyone role spec to add to the list of roles.

Returns:

This spec.

addChannel

public GuildCreateSpec addChannel(String name,
                                  Channel.Type type)

Adds the channel to the list of channels for the created Guild.

Parameters:

name - The name of the channel.

type - The type of the channel.

Returns:

This spec.

setAfkChannelId

public GuildCreateSpec setAfkChannelId(@Nullable
                                       Snowflake id)

Sets the ID of the AFK channel for the created Guild.

Parameters:

id - id for afk channel

Returns:

This spec.

setAfkTimeout

public GuildCreateSpec setAfkTimeout(@Nullable
                                     Integer afkTimeout)

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

Parameters:

afkTimeout - The AFK timeout, in seconds.

Returns:

This spec.

setSystemChannelId

public GuildCreateSpec setSystemChannelId(@Nullable
                                          Snowflake id)

Sets the id of the channel where guild notices such as welcome messages and boost events are posted for the created Guild.

Parameters:

id - The id of the channel where guild notices such as welcome messages and boost events are posted.

Returns:

This spec.

setSystemChannelFlags

public GuildCreateSpec setSystemChannelFlags(@Nullable
                                             Guild.SystemChannelFlag... flags)

Sets the system channel flags for the created Guild.

Parameters:

flags - The system channel flags.

Returns:

This spec.

asRequest

public discord4j.discordjson.json.GuildCreateRequest asRequest()

Specified by:

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