Package net.dv8tion.jda.api.entities.templates

Class TemplateGuild

java.lang.Object

net.dv8tion.jda.api.entities.templates.TemplateGuild

All Implemented Interfaces:

ISnowflake

public class TemplateGuild
extends Object
implements ISnowflake

POJO for the guild information provided by a template.

See Also:

• Template.getGuild()

Constructor Summary

Constructors

Constructor	Description
TemplateGuild(long id, String name, String description, String iconId, Guild.VerificationLevel verificationLevel, Guild.NotificationLevel notificationLevel, Guild.ExplicitContentLevel explicitContentLevel, DiscordLocale locale, Guild.Timeout afkTimeout, TemplateChannel afkChannel, TemplateChannel systemChannel, List<TemplateRole> roles, List<TemplateChannel> channels)

Method Summary

Modifier and Type	Method	Description
TemplateChannel	getAfkChannel()	Provides the TemplateChannel that has been set as the channel which Members will be moved to after they have been inactive in a VoiceChannel for longer than getAfkTimeout().
Guild.Timeout	getAfkTimeout()	Returns the AFK Timeout for this guild.
@Unmodifiable List<TemplateChannel>	getChannels()	Gets all Channels in this Guild.
Guild.NotificationLevel	getDefaultNotificationLevel()	Returns the NotificationLevel of this guild.
String	getDescription()	The description for this guild.
Guild.ExplicitContentLevel	getExplicitContentLevel()	Returns the ExplicitContentLevel of this guild.
ImageProxy	getIcon()	Returns an ImageProxy for this template guild's icon.
String	getIconId()	The icon id of this guild.
String	getIconUrl()	The icon url of this guild.
long	getIdLong()	The Snowflake id of this entity.
DiscordLocale	getLocale()	The preferred locale for this guild.
String	getName()	The name of this guild.
@Unmodifiable List<TemplateRole>	getRoles()	Gets all Roles in this Guild.
TemplateChannel	getSystemChannel()	Provides the TemplateChannel that has been set as the channel which newly joined Members will be announced in.
Guild.VerificationLevel	getVerificationLevel()	Returns the VerificationLevel of this guild.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Constructor Details

TemplateGuild

public TemplateGuild(long id,
 String name,
 String description,
 String iconId,
 Guild.VerificationLevel verificationLevel,
 Guild.NotificationLevel notificationLevel,
 Guild.ExplicitContentLevel explicitContentLevel,
 DiscordLocale locale,
 Guild.Timeout afkTimeout,
 TemplateChannel afkChannel,
 TemplateChannel systemChannel,
 List<TemplateRole> roles,
 List<TemplateChannel> channels)

Method Details

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

getName

@Nonnull
public String getName()

The name of this guild.

Returns:

The guild's name

getDescription

@Nullable
public String getDescription()

The description for this guild.
This is displayed in the server browser below the guild name for verified guilds.

Returns:

The description

getIconId

@Nullable
public String getIconId()

The icon id of this guild.

Returns:

The guild's icon id

See Also:

• getIconUrl()

getIconUrl

@Nullable
public String getIconUrl()

The icon url of this guild.

Returns:

The guild's icon url

See Also:

• getIconId()

getIcon

@Nullable
public ImageProxy getIcon()

Returns an ImageProxy for this template guild's icon.

Returns:

Possibly-null ImageProxy of this template guild's icon

See Also:

• getIconUrl()

getVerificationLevel

@Nonnull
public Guild.VerificationLevel getVerificationLevel()

Returns the VerificationLevel of this guild.

Returns:

the verification level of the guild

getDefaultNotificationLevel

@Nonnull
public Guild.NotificationLevel getDefaultNotificationLevel()

Returns the NotificationLevel of this guild.

Returns:

the notification level of the guild

getExplicitContentLevel

@Nonnull
public Guild.ExplicitContentLevel getExplicitContentLevel()

Returns the ExplicitContentLevel of this guild.

Returns:

the explicit content level of the guild

getLocale

@Nonnull
public DiscordLocale getLocale()

The preferred locale for this guild.

Returns:

The preferred DiscordLocale for this guild

getAfkTimeout

@Nonnull
public Guild.Timeout getAfkTimeout()

Returns the AFK Timeout for this guild.

Returns:

the afk timeout for this guild

getAfkChannel

@Nullable
public TemplateChannel getAfkChannel()

Provides the TemplateChannel that has been set as the channel which Members will be moved to after they have been inactive in a VoiceChannel for longer than getAfkTimeout().
If no channel has been set as the AFK channel, this returns null.

Returns:

Possibly-null TemplateChannel that is the AFK Channel.

getSystemChannel

@Nullable
public TemplateChannel getSystemChannel()

Provides the TemplateChannel that has been set as the channel which newly joined Members will be announced in.
If no channel has been set as the system channel, this returns null.

Returns:

Possibly-null TemplateChannel that is the system Channel.

getRoles

@Nonnull
public @Unmodifiable List<TemplateRole> getRoles()

Gets all Roles in this Guild.

Returns:

An immutable List of Roles.

getChannels

@Nonnull
public @Unmodifiable List<TemplateChannel> getChannels()

Gets all Channels in this Guild.

Returns:

An immutable List of Channels.