Class TemplateGuild
java.lang.Object
net.dv8tion.jda.api.entities.templates.TemplateGuild
- All Implemented Interfaces:
ISnowflake
POJO for the guild information provided by a template.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionTemplateGuild(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 TypeMethodDescriptionProvides theTemplateChannelthat has been set as the channel whichMemberswill be moved to after they have been inactive in aVoiceChannelfor longer thangetAfkTimeout().Returns theAFK Timeoutfor this guild.@Unmodifiable List<TemplateChannel>Returns theNotificationLevelof this guild.The description for this guild.Returns theExplicitContentLevelof this guild.getIcon()Returns anImageProxyfor this template guild's icon.The icon id of this guild.The icon url of this guild.longThe Snowflake id of this entity.The preferred locale for this guild.getName()The name of this guild.@Unmodifiable List<TemplateRole>getRoles()Provides theTemplateChannelthat has been set as the channel which newly joinedMemberswill be announced in.Returns theVerificationLevelof this guild.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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: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.
-
getName
The name of this guild.- Returns:
- The guild's name
-
getDescription
The description for this guild.
This is displayed in the server browser below the guild name for verified guilds.- Returns:
- The description
-
getIconId
The icon id of this guild.- Returns:
- The guild's icon id
- See Also:
-
getIconUrl
The icon url of this guild.- Returns:
- The guild's icon url
- See Also:
-
getIcon
Returns anImageProxyfor this template guild's icon.- Returns:
- Possibly-null
ImageProxyof this template guild's icon - See Also:
-
getVerificationLevel
Returns theVerificationLevelof this guild.- Returns:
- the verification level of the guild
-
getDefaultNotificationLevel
Returns theNotificationLevelof this guild.- Returns:
- the notification level of the guild
-
getExplicitContentLevel
Returns theExplicitContentLevelof this guild.- Returns:
- the explicit content level of the guild
-
getLocale
The preferred locale for this guild.- Returns:
- The preferred
DiscordLocalefor this guild
-
getAfkTimeout
Returns theAFK Timeoutfor this guild.- Returns:
- the afk timeout for this guild
-
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
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
- Returns:
- An immutable List of
Roles.
-
getChannels
- Returns:
- An immutable List of
Channels.
-