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

Class GenericPermissionOverrideEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

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

net.dv8tion.jda.api.events.guild.override.GenericPermissionOverrideEvent

All Implemented Interfaces:

GenericEvent

Direct Known Subclasses:

PermissionOverrideCreateEvent, PermissionOverrideDeleteEvent, PermissionOverrideUpdateEvent

public class GenericPermissionOverrideEvent
extends GenericGuildEvent

Indicates that a PermissionOverride for a GuildChannel was created, deleted, or updated.
Every guild channel override event is a subclass of this event and can be casted

Can be used to detect that any guild channel override event was fired

Constructor Summary

Constructors

Constructor	Description
GenericPermissionOverrideEvent(JDA api, long responseNumber, GuildChannel channel, PermissionOverride override)

Method Summary

Modifier and Type	Method	Description
Category	getCategory()	The Category this override belongs to.
GuildChannel	getChannel()	The GuildChannel this override belongs to.
ChannelType	getChannelType()	The ChannelType of the GuildChannel this override belongs to.
Member	getMember()	The Member for the override.
NewsChannel	getNewsChannel()	The NewsChannel this override belongs to.
IPermissionHolder	getPermissionHolder()	The IPermissionHolder for the override.
PermissionOverride	getPermissionOverride()	The affected PermissionOverride that was updated.
Role	getRole()	The Role for the override.
StoreChannel	getStoreChannel()	The StoreChannel this override belongs to.
TextChannel	getTextChannel()	The TextChannel this override belongs to.
VoiceChannel	getVoiceChannel()	The VoiceChannel this override belongs to.
boolean	isMemberOverride()	Whether this override was for a member.
boolean	isRoleOverride()	Whether this override was for a role.

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

GenericPermissionOverrideEvent

public GenericPermissionOverrideEvent(@Nonnull
                                      JDA api,
                                      long responseNumber,
                                      @Nonnull
                                      GuildChannel channel,
                                      @Nonnull
                                      PermissionOverride override)

Method Detail

getChannelType

@Nonnull
public ChannelType getChannelType()

The ChannelType of the GuildChannel this override belongs to.

Returns:

The ChannelType

getChannel

@Nonnull
public GuildChannel getChannel()

The GuildChannel this override belongs to.

Returns:

The GuildChannel

getTextChannel

@Nonnull
public TextChannel getTextChannel()

The TextChannel this override belongs to.

Returns:

TextChannel

Throws:

IllegalStateException - If the override does not belong to a TextChannel

See Also:

getChannel(), getChannelType()

getNewsChannel

@Nonnull
public NewsChannel getNewsChannel()

The NewsChannel this override belongs to.

Returns:

NewsChannel

Throws:

IllegalStateException - If the override does not belong to a NewsChannel

See Also:

getChannel(), getChannelType()

getVoiceChannel

@Nonnull
public VoiceChannel getVoiceChannel()

The VoiceChannel this override belongs to.

Returns:

VoiceChannel

Throws:

IllegalStateException - If the override does not belong to a VoiceChannel

See Also:

getChannel(), getChannelType()

getStoreChannel

@Nonnull
public StoreChannel getStoreChannel()

The StoreChannel this override belongs to.

Returns:

StoreChannel

Throws:

IllegalStateException - If the override does not belong to a StoreChannel

See Also:

getChannel(), getChannelType()

getCategory

@Nonnull
public Category getCategory()

The Category this override belongs to.
Note: This is not the same as getChannel().getParentCategory()!

Returns:

Category

Throws:

IllegalStateException - If the override does not belong to a Category

See Also:

getChannel(), getChannelType()

getPermissionOverride

@Nonnull
public PermissionOverride getPermissionOverride()

The affected PermissionOverride that was updated.

Returns:

The override

isRoleOverride

public boolean isRoleOverride()

Whether this override was for a role.
This means getRole() is likely not null.

Returns:

True, if this override is for a role

isMemberOverride

public boolean isMemberOverride()

Whether this override was for a member.
Note that getMember() might still be null if the member isn't cached or there is a discord inconsistency.

Returns:

True, if this override is for a member

getPermissionHolder

@Nullable
public IPermissionHolder getPermissionHolder()

The IPermissionHolder for the override.
This can be a Member or Role. If the role or member are not cached then this will be null.

Returns:

Possibly-null permission holder

getMember

@Nullable
public Member getMember()

The Member for the override.
This can be null if the member is not cached or there is a discord inconsistency.

Returns:

Possibly-null member

getRole

@Nullable
public Role getRole()

The Role for the override.

Returns:

Possibly-null role