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 java.lang.Object
implements ISnowflake

POJO for the guild information provided by a template.

See Also:

Template.getGuild()

Constructor Summary

Constructors

Constructor

Description

TemplateGuild(long id, java.lang.String name, java.lang.String description, java.lang.String region, java.lang.String iconId, Guild.VerificationLevel verificationLevel, Guild.NotificationLevel notificationLevel, Guild.ExplicitContentLevel explicitContentLevel, java.util.Locale locale, Guild.Timeout afkTimeout, TemplateChannel afkChannel, TemplateChannel systemChannel, java.util.List<TemplateRole> roles, java.util.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.
java.util.List<TemplateChannel>	getChannels()	Gets all Channels in this Guild.
Guild.NotificationLevel	getDefaultNotificationLevel()	Returns the NotificationLevel of this guild.
java.lang.String	getDescription()	The description for this guild.
Guild.ExplicitContentLevel	getExplicitContentLevel()	Returns the ExplicitContentLevel of this guild.
java.lang.String	getIconId()	The icon id of this guild.
java.lang.String	getIconUrl()	The icon url of this guild.
long	getIdLong()	The Snowflake id of this entity.
java.util.Locale	getLocale()	The preferred locale for this guild.
java.lang.String	getName()	The name of this guild.
Region	getRegion()	Deprecated. Guilds no longer have the Region option.
java.lang.String	getRegionRaw()	Deprecated. Guilds no longer have the Region option.
java.util.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 Detail

TemplateGuild

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

Method Detail

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 java.lang.String getName()

The name of this guild.

Returns:

The guild's name

getDescription

@Nullable
public java.lang.String getDescription()

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

Returns:

The description

getRegion

@Nonnull
@Deprecated
@ForRemoval(deadline="5.0.0")
public Region getRegion()

Deprecated.

Guilds no longer have the Region option. Use VoiceChannel.getRegion() instead.

The Voice Region that this Guild is using for audio connections.
If the Region is not recognized, this returns UNKNOWN but you can still use the getRegionRaw() to retrieve the raw name this region has.

Returns:

The the audio Region this Guild is using for audio connections. Can return Region.UNKNOWN.

getRegionRaw

@Nonnull
@Deprecated
@ForRemoval(deadline="5.0.0")
public java.lang.String getRegionRaw()

Deprecated.

Guilds no longer have the Region option. Use VoiceChannel.getRegion() instead.

The raw voice region name that this Guild is using for audio connections.
This is resolved to an enum constant of Region by getRegion()!

Returns:

Raw region name

getIconId

@Nullable
public java.lang.String getIconId()

The icon id of this guild.

Returns:

The guild's icon id

See Also:

getIconUrl()

getIconUrl

@Nullable
public java.lang.String getIconUrl()

The icon url of this guild.

Returns:

The guild's icon url

See Also:

getIconId()

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 java.util.Locale getLocale()

The preferred locale for this guild.

Returns:

The preferred Locale 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 java.util.List<TemplateRole> getRoles()

Gets all Roles in this Guild.

Returns:

An immutable List of Roles.

getChannels

@Nonnull
public java.util.List<TemplateChannel> getChannels()

Gets all Channels in this Guild.

Returns:

An immutable List of Channels.