All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.dv8tion.jda.api.events.guild.scheduledevent.update.ScheduledEventUpdateStatusEvent Maven / Gradle / Ivy

Go to download

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

There is a newer version: 5.1.0
Show newest version
/*
 * 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.update;

import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.ScheduledEvent;
import net.dv8tion.jda.api.utils.cache.CacheFlag;

import javax.annotation.Nonnull;

/**
 * Indicates that the {@link ScheduledEvent#getStatus() status} of a {@link ScheduledEvent} has changed. The status
 * of a {@link ScheduledEvent} represents if it is currently active, canceled, or completed.
 *
 * 

Can be used to detect when the {@link ScheduledEvent} status has changed. * *

Identifier: {@code status} * *

Requirements
* *

This event requires 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! * *

Discord does not specifically tell us about the updates, but merely tells us the * {@link ScheduledEvent ScheduledEvent} was updated and gives us the updated {@link ScheduledEvent ScheduledEvent} object. * In order to fire a specific event like this we need to have the old {@link ScheduledEvent ScheduledEvent} cached to compare against. */ public class ScheduledEventUpdateStatusEvent extends GenericScheduledEventUpdateEvent { public static final String IDENTIFIER = "status"; public ScheduledEventUpdateStatusEvent(@Nonnull JDA api, long responseNumber, @Nonnull ScheduledEvent scheduledEvent, @Nonnull ScheduledEvent.Status previous) { super(api, responseNumber, scheduledEvent, previous, scheduledEvent.getStatus(), IDENTIFIER); } /** * The old {@link ScheduledEvent#getStatus() status}. * * @return The old status */ @Nonnull public ScheduledEvent.Status getOldStatus() { return getOldValue(); } /** * The new {@link ScheduledEvent#getStatus() status}. * * @return The new status */ @Nonnull public ScheduledEvent.Status getNewStatus() { return getNewValue(); } @Nonnull @Override public ScheduledEvent.Status getOldValue() { return super.getOldValue(); } @Nonnull @Override public ScheduledEvent.Status getNewValue() { return super.getNewValue(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy