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 TemplateChannelgetAfkChannel()Provides theTemplateChannelthat has been set as the channel whichMemberswill be moved to after they have been inactive in aVoiceChannelfor longer thangetAfkTimeout().Guild.TimeoutgetAfkTimeout()Returns theAFK Timeoutfor this guild.List<TemplateChannel>getChannels()Guild.NotificationLevelgetDefaultNotificationLevel()Returns theNotificationLevelof this guild.StringgetDescription()The description for this guild.Guild.ExplicitContentLevelgetExplicitContentLevel()Returns theExplicitContentLevelof this guild.StringgetIconId()The icon id of this guild.StringgetIconUrl()The icon url of this guild.longgetIdLong()The Snowflake id of this entity.LocalegetLocale()The preferred locale for this guild.StringgetName()The name of this guild.List<TemplateRole>getRoles()TemplateChannelgetSystemChannel()Provides theTemplateChannelthat has been set as the channel which newly joinedMemberswill be announced in.Guild.VerificationLevelgetVerificationLevel()Returns theVerificationLevelof 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:ISnowflakeThe Snowflake id of this entity. This is unique to every entity and will never change.- Specified by:
getIdLongin 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 theVerificationLevelof this guild.- Returns:
- the verification level of the guild
-
getDefaultNotificationLevel
@Nonnull public Guild.NotificationLevel getDefaultNotificationLevel()
Returns theNotificationLevelof this guild.- Returns:
- the notification level of the guild
-
getExplicitContentLevel
@Nonnull public Guild.ExplicitContentLevel getExplicitContentLevel()
Returns theExplicitContentLevelof this guild.- Returns:
- the explicit content level of the guild
-
getLocale
@Nonnull public Locale getLocale()
The preferred locale for this guild.- Returns:
- The preferred
Localefor this guild
-
getAfkTimeout
@Nonnull public Guild.Timeout getAfkTimeout()
Returns theAFK Timeoutfor this guild.- Returns:
- the afk timeout for this guild
-
getAfkChannel
@Nullable public TemplateChannel getAfkChannel()
Provides theTemplateChannelthat has been set as the channel whichMemberswill be moved to after they have been inactive in aVoiceChannelfor longer thangetAfkTimeout().
If no channel has been set as the AFK channel, this returnsnull.- Returns:
- Possibly-null
TemplateChannelthat is the AFK Channel.
-
getSystemChannel
@Nullable public TemplateChannel getSystemChannel()
Provides theTemplateChannelthat has been set as the channel which newly joinedMemberswill be announced in.
If no channel has been set as the system channel, this returnsnull.- Returns:
- Possibly-null
TemplateChannelthat 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.
-
-