net.dv8tion.jda.api.events.user.UserActivityStartEvent 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.user;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Activity;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.events.user.update.GenericUserPresenceEvent;
import net.dv8tion.jda.api.utils.cache.CacheFlag;
import javax.annotation.Nonnull;
/**
* Indicates that a {@link net.dv8tion.jda.api.entities.User User} has started an {@link Activity}
* in a {@link Guild}.
*
* This is fired for every {@link Guild} the user is part of. If the title of a stream
* changes a start event is fired before an end event which will replace the activity.
*
*
The activities of the {@link Member} are updated before all the start/end events are fired.
* This means you can check {@link Member#getActivities()} when handling this event and it will already
* contain all new activities, even ones that have not yet fired the start event.
*
*
Requirements
*
*
This event requires the {@link net.dv8tion.jda.api.requests.GatewayIntent#GUILD_PRESENCES GUILD_PRESENCES} 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.
*
*
This also requires {@link net.dv8tion.jda.api.utils.cache.CacheFlag#ACTIVITY CacheFlag.ACTIVITY} to be enabled.
* You can enable the cache flag with {@link net.dv8tion.jda.api.JDABuilder#enableCache(CacheFlag, CacheFlag...) enableCache(CacheFlag.ACTIVITY)}.
*/
public class UserActivityStartEvent extends GenericUserEvent implements GenericUserPresenceEvent
{
private final Activity newActivity;
private final Member member;
public UserActivityStartEvent(@Nonnull JDA api, long responseNumber, @Nonnull Member member, @Nonnull Activity newActivity)
{
super(api, responseNumber, member.getUser());
this.newActivity = newActivity;
this.member = member;
}
/**
* The new activity
*
* @return The activity
*/
public Activity getNewActivity()
{
return newActivity;
}
@Nonnull
@Override
public Guild getGuild()
{
return member.getGuild();
}
@Nonnull
@Override
public Member getMember()
{
return member;
}
}