Package net.dv8tion.jda.internal.entities

Class GuildWelcomeScreenImpl.ChannelImpl

java.lang.Object

net.dv8tion.jda.internal.entities.GuildWelcomeScreenImpl.ChannelImpl

All Implemented Interfaces:

GuildWelcomeScreen.Channel, ISnowflake, SerializableData

Enclosing class:

GuildWelcomeScreenImpl

public static class GuildWelcomeScreenImpl.ChannelImpl
extends Object
implements GuildWelcomeScreen.Channel

POJO for the recommended channels information provided by a welcome screen.
Recommended channels are shown in the welcome screen after joining a server.

See Also:

• GuildWelcomeScreen.getChannels()

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.GuildWelcomeScreen.Channel

MAX_DESCRIPTION_LENGTH

Constructor Summary

Constructors

Constructor	Description
ChannelImpl(Guild guild, long id, String description, EmojiUnion emoji)

Method Summary

Modifier and Type	Method	Description
GuildChannel	getChannel()	Returns the GuildChannel that is linked to this recommended channel.
String	getDescription()	The description of this recommended channel shown in the welcome screen.
EmojiUnion	getEmoji()	The emoji that is used for this recommended channel.
Guild	getGuild()	The Guild, or null if this welcome channel came from an Invite
long	getIdLong()	The id of this recommended channel.
DataObject	toData()	Serialized DataObject for this object.

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

ChannelImpl

public ChannelImpl(@Nullable
 Guild guild,
 long id,
 @Nonnull
 String description,
 @Nullable
 EmojiUnion emoji)

Method Details

getGuild

@Nullable
public Guild getGuild()

Description copied from interface: GuildWelcomeScreen.Channel

The Guild, or null if this welcome channel came from an Invite

Specified by:

getGuild in interface GuildWelcomeScreen.Channel

Returns:

The Guild, or null

getIdLong

public long getIdLong()

Description copied from interface: GuildWelcomeScreen.Channel

The id of this recommended channel.

Specified by:

getIdLong in interface GuildWelcomeScreen.Channel

Specified by:

getIdLong in interface ISnowflake

Returns:

The id of this recommended channel

getChannel

@Nullable
public GuildChannel getChannel()

Description copied from interface: GuildWelcomeScreen.Channel

Returns the GuildChannel that is linked to this recommended channel.
This will be null if the linked channel was deleted, or if the welcome screen comes from an invite guild.

Specified by:

getChannel in interface GuildWelcomeScreen.Channel

Returns:

The GuildChannel that is linked to this recommended channel or null

getDescription

@Nonnull
public String getDescription()

Description copied from interface: GuildWelcomeScreen.Channel

The description of this recommended channel shown in the welcome screen.

Specified by:

getDescription in interface GuildWelcomeScreen.Channel

Returns:

The description of this recommended channel

getEmoji

@Nullable
public EmojiUnion getEmoji()

Description copied from interface: GuildWelcomeScreen.Channel

The emoji that is used for this recommended channel.
This will return null if no emoji was set

The emoji will always be from this guild, if not a unicode emoji
CustomEmoji.isAnimated() will always return false if:

• This welcome screen came from an invite's guild
• CacheFlag.EMOJI is disabled

Specified by:

getEmoji in interface GuildWelcomeScreen.Channel

Returns:

The emoji that is used for this recommended channel or null

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject