com.github.twitch4j.chat.events.channel.ListModsEvent Maven / Gradle / Ivy

Go to download
package com.github.twitch4j.chat.events.channel;

import com.github.twitch4j.chat.events.AbstractChannelEvent;
import com.github.twitch4j.common.events.domain.EventChannel;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import lombok.ToString;
import lombok.Value;
import org.jetbrains.annotations.ApiStatus;

import java.util.List;

/**
 * Called following a /mods message.
 *
 * @deprecated Twitch will decommission this event on February 18, 2023; migrate to TwitchHelix#getModerators
 */
@Value
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2.0.0")
public class ListModsEvent extends AbstractChannelEvent {

    /**
     * The login names of the moderators of this channel.
     */
    List moderators;

    /**
     * Event Constructor
     *
     * @param channel    The channel that this event originates from.
     * @param moderators The login names of the moderators of this channel.
     */
    public ListModsEvent(@NonNull EventChannel channel, @NonNull List moderators) {
        super(channel);
        this.moderators = moderators;
    }

}