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, Locale locale, Guild.Timeout afkTimeout, TemplateChannel afkChannel, TemplateChannel systemChannel, List<TemplateRole> roles, List<TemplateChannel> channels)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TemplateChannel
getAfkChannel()
Provides theTemplateChannel
that has been set as the channel whichMembers
will be moved to after they have been inactive in aVoiceChannel
for longer thangetAfkTimeout()
.Guild.Timeout
getAfkTimeout()
Returns theAFK Timeout
for this guild.List<TemplateChannel>
getChannels()
Guild.NotificationLevel
getDefaultNotificationLevel()
Returns theNotificationLevel
of this guild.String
getDescription()
The description for this guild.Guild.ExplicitContentLevel
getExplicitContentLevel()
Returns theExplicitContentLevel
of this guild.String
getIconId()
The icon id of this guild.String
getIconUrl()
The icon url of this guild.long
getIdLong()
The Snowflake id of this entity.Locale
getLocale()
The preferred locale for this guild.String
getName()
The name of this guild.List<TemplateRole>
getRoles()
TemplateChannel
getSystemChannel()
Provides theTemplateChannel
that has been set as the channel which newly joinedMembers
will be announced in.Guild.VerificationLevel
getVerificationLevel()
Returns theVerificationLevel
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, String name, String description, String iconId, Guild.VerificationLevel verificationLevel, Guild.NotificationLevel notificationLevel, Guild.ExplicitContentLevel explicitContentLevel, Locale locale, Guild.Timeout afkTimeout, TemplateChannel afkChannel, TemplateChannel systemChannel, List<TemplateRole> roles, 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 interfaceISnowflake
- Returns:
- Long containing the Id.
-
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()
-
getVerificationLevel
@Nonnull public Guild.VerificationLevel getVerificationLevel()
Returns theVerificationLevel
of this guild.- Returns:
- the verification level of the guild
-
getDefaultNotificationLevel
@Nonnull public Guild.NotificationLevel getDefaultNotificationLevel()
Returns theNotificationLevel
of this guild.- Returns:
- the notification level of the guild
-
getExplicitContentLevel
@Nonnull public Guild.ExplicitContentLevel getExplicitContentLevel()
Returns theExplicitContentLevel
of this guild.- Returns:
- the explicit content level of the guild
-
getLocale
@Nonnull public Locale getLocale()
The preferred locale for this guild.- Returns:
- The preferred
Locale
for this guild
-
getAfkTimeout
@Nonnull public Guild.Timeout getAfkTimeout()
Returns theAFK Timeout
for this guild.- Returns:
- the afk timeout for this guild
-
getAfkChannel
@Nullable public TemplateChannel getAfkChannel()
Provides theTemplateChannel
that has been set as the channel whichMembers
will be moved to after they have been inactive in aVoiceChannel
for longer thangetAfkTimeout()
.
If no channel has been set as the AFK channel, this returnsnull
.- Returns:
- Possibly-null
TemplateChannel
that is the AFK Channel.
-
getSystemChannel
@Nullable public TemplateChannel getSystemChannel()
Provides theTemplateChannel
that has been set as the channel which newly joinedMembers
will be announced in.
If no channel has been set as the system channel, this returnsnull
.- Returns:
- Possibly-null
TemplateChannel
that is the system Channel.
-
getRoles
@Nonnull public List<TemplateRole> getRoles()
- Returns:
- An immutable List of
Roles
.
-
getChannels
@Nonnull public List<TemplateChannel> getChannels()
- Returns:
- An immutable List of
Channels
.
-
-