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

Go to download

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 net.dv8tion.jda.api.events.thread.GenericThreadEvent;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Indicates that a {@link ThreadMember} event has been fired.
 * If you can see a {@link ThreadChannel}, you will receive all derived thread member events for it.
 * Current derived events:
 * 
 *     {@link ThreadMemberJoinEvent}
 *     {@link ThreadMemberLeaveEvent}
 * 
 *
 * @see Member
 * @see ThreadChannel
 * @see ThreadMember
 */
public class GenericThreadMemberEvent extends GenericThreadEvent
{
    protected final long threadMemberId;
    protected final ThreadMember threadMember;

    public GenericThreadMemberEvent(@Nonnull JDA api, long responseNumber, ThreadChannel thread, long threadMemberId, ThreadMember threadMember)
    {
        super(api, responseNumber, thread);

        this.threadMemberId = threadMemberId;
        this.threadMember = threadMember;
    }

    /**
     * The id of the {@link ThreadMember} that fired this and derived event.
     *
     * @return Never-null String containing the ID.
     */
    @Nonnull
    public String getThreadMemberId()
    {
        return Long.toUnsignedString(getThreadMemberIdLong());
    }

    /**
     * The id of the {@link ThreadMember}.
     *
     * @return Long containing the Id.
     */
    public long getThreadMemberIdLong()
    {
        return threadMemberId;
    }

    /**
     * The {@link ThreadMember} of the event that has been fired.
     *
     * @return The {@link ThreadMember} of the event that has been fired.
     */
    @Nullable
    public ThreadMember getThreadMember()
    {
        return threadMember;
    }

    /**
     * The {@link ThreadMember} as a guild {@link Member}.
     *
     * @return The {@link ThreadMember} as a guild {@link Member}.
     */
    @Nullable
    public Member getMember()
    {
        return getGuild().getMemberById(threadMemberId);
    }
}