net.dv8tion.jda.api.events.guild.scheduledevent.GenericScheduledEventGatewayEvent 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.scheduledevent;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.ScheduledEvent;
import net.dv8tion.jda.api.events.guild.GenericGuildEvent;
import net.dv8tion.jda.api.utils.cache.CacheFlag;
import javax.annotation.Nonnull;
/**
* Indicates that a gateway event relating to a {@link ScheduledEvent} has been fired.
*
* It should be noted that a {@link ScheduledEvent} is not an
* actual gateway event found in the {@link net.dv8tion.jda.api.events} package, but are rather entities similar to
* {@link net.dv8tion.jda.api.entities.User User} or {@link net.dv8tion.jda.api.entities.channel.concrete.TextChannel TextChannel} objects
* representing a scheduled event.
*
*
Requirements
*
*
These events require the {@link net.dv8tion.jda.api.requests.GatewayIntent#SCHEDULED_EVENTS SCHEDULED_EVENTS} intent and {@link CacheFlag#SCHEDULED_EVENTS} to be enabled.
*
{@link net.dv8tion.jda.api.JDABuilder#createDefault(String) createDefault(String)} and
* {@link net.dv8tion.jda.api.JDABuilder#createLight(String) createLight(String)} disable this by default!
*
*
This class may be used to check if a gateway event is related to a {@link ScheduledEvent}
* as all gateway events in the {@link net.dv8tion.jda.api.events.guild.scheduledevent} package extend this class.
*/
public abstract class GenericScheduledEventGatewayEvent extends GenericGuildEvent
{
protected final ScheduledEvent scheduledEvent;
public GenericScheduledEventGatewayEvent(@Nonnull JDA api, long responseNumber, @Nonnull ScheduledEvent scheduledEvent)
{
super(api, responseNumber, scheduledEvent.getGuild());
this.scheduledEvent = scheduledEvent;
}
/**
* The {@link ScheduledEvent}
*
* @return The Scheduled Event
*/
@Nonnull
public ScheduledEvent getScheduledEvent()
{
return scheduledEvent;
}
}