net.dv8tion.jda.api.events.thread.member.ThreadMemberLeaveEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation

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

There is a newer version: 5.1.0

/*
 * 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.thread.member;

import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.entities.ThreadMember;
import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;

import javax.annotation.Nonnull;

/**
 * Indicates that a guild {@link Member} left a {@link ThreadChannel}.
 *
 * @see ThreadChannel
 * @see ThreadMember
 */
public class ThreadMemberLeaveEvent extends GenericThreadMemberEvent
{
    public ThreadMemberLeaveEvent(@Nonnull JDA api, long responseNumber, ThreadChannel thread, long threadMemberId, ThreadMember threadMember)
    {
        super(api, responseNumber, thread, threadMemberId, threadMember);
    }

    /**
     * The {@link ThreadMember} that just left the thread.
     * This entity will not be present in {@link ThreadChannel#getThreadMembers()} list.
     * 
     * @return The {@link ThreadMember} that just left the thread
     */
    @Nonnull
    @Override
    public ThreadMember getThreadMember()
    {
        return super.getThreadMember();
    }

    /**
     * The {@link ThreadMember} that just left the thread as a guild {@link Member}.
     *
     * @return The {@link ThreadMember} that just left the thread as a guild {@link Member}.
     */
    @Nonnull
    @Override
    public Member getMember()
    {
        //Explicitly override the getter from the super class to use the member return in the thread member itself because
        // the ThreadMember will always have the Member while the Guild itself might not because of
        // the ChunkingFilter or a lack of GUILD_MEMBERS intent.
        return getThreadMember().getMember();
    }
}