net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent 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.interaction.component;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.interactions.components.buttons.Button;
import net.dv8tion.jda.api.interactions.components.buttons.ButtonInteraction;
import javax.annotation.Nonnull;
/**
* Indicates that a custom {@link Button} on one of the bots messages was clicked by a user.
*
* This fires when a user clicks one of the custom buttons attached to a bot or webhook message.
*
*
Requirements
* To receive these events, you must unset the Interactions Endpoint URL in your application dashboard.
* You can simply remove the URL for this endpoint in your settings at the Discord Developers Portal.
*/
public class ButtonInteractionEvent extends GenericComponentInteractionCreateEvent implements ButtonInteraction
{
private final ButtonInteraction interaction;
public ButtonInteractionEvent(@Nonnull JDA api, long responseNumber, @Nonnull ButtonInteraction interaction)
{
super(api, responseNumber, interaction);
this.interaction = interaction;
}
@Nonnull
@Override
public ButtonInteraction getInteraction()
{
return interaction;
}
@Nonnull
@Override
public Button getComponent()
{
return interaction.getComponent();
}
@Nonnull
@Override
public Button getButton()
{
return interaction.getButton();
}
}