net.dv8tion.jda.api.events.channel.forum.GenericForumTagEvent 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.channel.forum;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.channel.attribute.IPostContainer;
import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
import net.dv8tion.jda.api.entities.channel.forums.ForumTag;
import net.dv8tion.jda.api.events.Event;
import javax.annotation.Nonnull;
import java.util.Collection;
/**
* Abstraction of all tags relating to {@link ForumTag} changes (excluding {@link ThreadChannel#getAppliedTags()}).
*
* Requirements
* This requires {@link net.dv8tion.jda.api.utils.cache.CacheFlag#FORUM_TAGS CacheFlag.FORUM_TAGS} to be enabled.
* {@link net.dv8tion.jda.api.JDABuilder#createLight(String, Collection) JDABuilder.createLight(...)} disables this by default.
*/
public abstract class GenericForumTagEvent extends Event
{
protected final IPostContainer channel;
protected final ForumTag tag;
public GenericForumTagEvent(@Nonnull JDA api, long responseNumber, @Nonnull IPostContainer channel, @Nonnull ForumTag tag)
{
super(api, responseNumber);
this.channel = channel;
this.tag = tag;
}
/**
* The {@link IPostContainer} which has been updated.
*
* @return The {@link IPostContainer}
*/
@Nonnull
public IPostContainer getChannel()
{
return channel;
}
/**
* The {@link ForumTag} that was affected by this event
*
* @return The {@link ForumTag}
*/
@Nonnull
public ForumTag getTag()
{
return tag;
}
}