net.dv8tion.jda.api.events.guild.invite.GenericGuildInviteEvent Maven / Gradle / Ivy
Show all versions of JDA Show documentation
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.events.guild.invite;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.Invite;
import net.dv8tion.jda.api.entities.channel.ChannelType;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.entities.channel.unions.GuildChannelUnion;
import net.dv8tion.jda.api.events.guild.GenericGuildEvent;
import javax.annotation.Nonnull;
/**
* Indicates that an {@link Invite} was created or deleted in a {@link Guild}.
*
Every GuildInviteEvent is derived from this event and can be casted.
*
* Can be used to detect any GuildInviteEvent.
*
*
Requirements
*
*
These events require the {@link net.dv8tion.jda.api.requests.GatewayIntent#GUILD_INVITES GUILD_INVITES} intent to be enabled.
*
These events will only fire for invite events that occur in channels where you can {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL MANAGE_CHANNEL}.
*/
public class GenericGuildInviteEvent extends GenericGuildEvent
{
private final String code;
private final GuildChannel channel;
public GenericGuildInviteEvent(@Nonnull JDA api, long responseNumber, @Nonnull String code, @Nonnull GuildChannel channel)
{
super(api, responseNumber, channel.getGuild());
this.code = code;
this.channel = channel;
}
/**
* The invite code.
*
This can be converted to a url with {@code discord.gg/}.
*
* @return The invite code
*/
@Nonnull
public String getCode()
{
return code;
}
/**
* The invite url.
*
This uses the {@code https://discord.gg/} format.
*
* @return The invite url
*/
@Nonnull
public String getUrl()
{
return "https://discord.gg/" + code;
}
/**
* The {@link GuildChannel} this invite points to.
*
* @return {@link GuildChannel}
*/
@Nonnull
public GuildChannelUnion getChannel()
{
return (GuildChannelUnion) channel;
}
/**
* The {@link ChannelType} for of the {@link #getChannel() channel} this invite points to.
*
* @return {@link ChannelType}
*/
@Nonnull
public ChannelType getChannelType()
{
return channel.getType();
}
}