Package net.dv8tion.jda.api.events.guild.invite

Class GenericGuildInviteEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.guild.GenericGuildEvent

net.dv8tion.jda.api.events.guild.invite.GenericGuildInviteEvent

All Implemented Interfaces:

GenericEvent

Direct Known Subclasses:

GuildInviteCreateEvent, GuildInviteDeleteEvent

public class GenericGuildInviteEvent
extends GenericGuildEvent

Indicates that an Invite was created or deleted in a Guild.
Every GuildInviteEvent is derived from this event and can be casted.

Can be used to detect any GuildInviteEvent.

Requirements

These events require the GUILD_INVITES intent to be enabled.
These events will only fire for invite events that occur in channels where you can MANAGE_CHANNEL.

Constructor Summary

Constructors

Constructor	Description
GenericGuildInviteEvent(JDA api, long responseNumber, java.lang.String code, GuildChannel channel)

Method Summary

Modifier and Type	Method	Description
Category	getCategory()	The Category this invite points to.
GuildChannel	getChannel()	The GuildChannel this invite points to.
ChannelType	getChannelType()	The ChannelType for of the channel this invite points to.
java.lang.String	getCode()	The invite code.
StageChannel	getStageChannel()	The StageChannel this invite points to.
StoreChannel	getStoreChannel()	The StoreChannel this invite points to.
TextChannel	getTextChannel()	The TextChannel this invite points to.
java.lang.String	getUrl()	The invite url.
VoiceChannel	getVoiceChannel()	The VoiceChannel this invite points to.

Methods inherited from class net.dv8tion.jda.api.events.guild.GenericGuildEvent

getGuild

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getResponseNumber

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericGuildInviteEvent

public GenericGuildInviteEvent(@Nonnull
                               JDA api,
                               long responseNumber,
                               @Nonnull
                               java.lang.String code,
                               @Nonnull
                               GuildChannel channel)

Method Detail

getCode

@Nonnull
public java.lang.String getCode()

The invite code.
This can be converted to a url with discord.gg/<code>.

Returns:

The invite code

getUrl

@Nonnull
public java.lang.String getUrl()

The invite url.
This uses the https://discord.gg/<code> format.

Returns:

The invite url

getChannel

@Nonnull
public GuildChannel getChannel()

The GuildChannel this invite points to.

Returns:

GuildChannel

getChannelType

@Nonnull
public ChannelType getChannelType()

The ChannelType for of the channel this invite points to.

Returns:

ChannelType

getTextChannel

@Nonnull
public TextChannel getTextChannel()

The TextChannel this invite points to.

Returns:

TextChannel

Throws:

java.lang.IllegalStateException - If this did not happen in a channel of type ChannelType.TEXT

See Also:

getChannel(), getChannelType()

getVoiceChannel

@Nonnull
public VoiceChannel getVoiceChannel()

The VoiceChannel this invite points to.

Returns:

VoiceChannel

Throws:

java.lang.IllegalStateException - If this did not happen in a voice channel or stage channel

See Also:

getChannel(), getChannelType()

getStageChannel

@Nonnull
public StageChannel getStageChannel()

The StageChannel this invite points to.

Returns:

StageChannel

Throws:

java.lang.IllegalStateException - If this did not happen in a channel of type ChannelType.STAGE

See Also:

getChannel(), getChannelType()

getStoreChannel

@Nonnull
public StoreChannel getStoreChannel()

The StoreChannel this invite points to.

Returns:

StoreChannel

Throws:

java.lang.IllegalStateException - If this did not happen in a channel of type ChannelType.STORE

See Also:

getChannel(), getChannelType()

getCategory

@Nonnull
public Category getCategory()

The Category this invite points to.

Returns:

Category

Throws:

java.lang.IllegalStateException - If this did not happen in a channel of type ChannelType.CATEGORY

See Also:

getChannel(), getChannelType()