Package net.dv8tion.jda.api.events.channel

Class GenericChannelEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.channel.GenericChannelEvent

All Implemented Interfaces:

GenericEvent

Direct Known Subclasses:

ChannelCreateEvent, ChannelDeleteEvent, GenericChannelUpdateEvent

public class GenericChannelEvent
extends Event

Top-level channel event type
All channel events JDA fires are derived from this class.

Can be used to check if an Object is a JDA event in EventListener implementations to distinguish what event is being fired.
Adapter implementation: ListenerAdapter

Constructor Summary

Constructors

Constructor	Description
GenericChannelEvent(JDA api, long responseNumber, Channel channel)

Method Summary

Modifier and Type	Method	Description
ChannelUnion	getChannel()	The Channel the event was fired from.
ChannelType	getChannelType()	The ChannelType of the channel the event was fired from.
Guild	getGuild()	The Guild in which this channel event happened.
boolean	isFromGuild()	Whether this channel event happened in a Guild.
boolean	isFromType(ChannelType type)	Used to determine if this event was received from a Channel of the ChannelType specified.

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

getJDA, getRawData, getResponseNumber, toString

Methods inherited from class java.lang.Object

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

Constructor Details

GenericChannelEvent

public GenericChannelEvent(@Nonnull
 JDA api,
 long responseNumber,
 Channel channel)

Method Details

isFromGuild

public boolean isFromGuild()

Whether this channel event happened in a Guild.
If this is false then getGuild() will throw an IllegalStateException.

Returns:

True, if getChannelType().isGuild() is true.

getChannelType

@Nonnull
public ChannelType getChannelType()

The ChannelType of the channel the event was fired from.

Returns:

The ChannelType of the channel the event was fired from.

isFromType

public boolean isFromType(ChannelType type)

Used to determine if this event was received from a Channel of the ChannelType specified.

Useful for restricting functionality to a certain type of channels.

Parameters:

type - The ChannelType to check against.

Returns:

True if the ChannelType which this message was received from is the same as the one specified by type.

getChannel

@Nonnull
public ChannelUnion getChannel()

The Channel the event was fired from.

Returns:

The ChannelType of the channel the event was fired from.

getGuild

@Nonnull
public Guild getGuild()

The Guild in which this channel event happened.
If this channel event was not received in a GuildChannel, this will throw an IllegalStateException.

Returns:

The Guild in which this channel event happened

Throws:

IllegalStateException - If this channel event did not happen in a GuildChannel.

See Also:

• isFromType(ChannelType)
• getChannelType()