All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.dv8tion.jda.api.events.guild.member.update.GuildMemberUpdateTimeOutEvent Maven / Gradle / Ivy

Go to download

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

There is a newer version: 5.1.0
Show newest version
/*
 * 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.guild.member.update;

import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Member;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.time.OffsetDateTime;

/**
 * Indicates that a {@link net.dv8tion.jda.api.entities.Member Member} had their time out changed.
 * 
This event does not fire for automatic time out expiration. * *

Can be used to retrieve members who had their time out changed and the triggering guild. * *

Identifier: {@code timeout_time} * *

Requirements
* *

This event requires the {@link net.dv8tion.jda.api.requests.GatewayIntent#GUILD_MEMBERS GUILD_MEMBERS} intent to be enabled. *
{@link net.dv8tion.jda.api.JDABuilder#createDefault(String) createDefault(String)} and * {@link net.dv8tion.jda.api.JDABuilder#createLight(String) createLight(String)} disable this by default! * *

Additionally, this event requires the {@link net.dv8tion.jda.api.utils.MemberCachePolicy MemberCachePolicy} * to cache the updated members. Discord does not specifically tell us about the updates, but merely tells us the * member was updated and gives us the updated member object. In order to fire a specific event like this we * need to have the old member cached to compare against. */ public class GuildMemberUpdateTimeOutEvent extends GenericGuildMemberUpdateEvent { public static final String IDENTIFIER = "timeout_time"; public GuildMemberUpdateTimeOutEvent(@Nonnull JDA api, long responseNumber, @Nonnull Member member, @Nullable OffsetDateTime previous) { super(api, responseNumber, member, previous, member.getTimeOutEnd(), IDENTIFIER); } /** * The old end of the time out * * @return The old end of the time out */ @Nullable public OffsetDateTime getOldTimeOutEnd() { return getOldValue(); } /** * The new end of the time out * * @return The new end of the time out */ @Nullable public OffsetDateTime getNewTimeOutEnd() { return getNewValue(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy