Package net.dv8tion.jda.internal.managers

Class PresenceImpl

java.lang.Object

net.dv8tion.jda.internal.managers.PresenceImpl

All Implemented Interfaces:

Presence

public class PresenceImpl
extends Object
implements Presence

The Presence associated with the provided JDA instance
Note that this does not automatically handle the 5/60 second rate limit!

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
PresenceImpl(JDAImpl jda)	Creates a new Presence representation for the provided JDAImpl instance

Method Summary

Modifier and Type	Method	Description
Activity	getActivity()	The current Activity for this session.
DataObject	getFullPresence()
static DataObject	getGameJson(Activity activity)
JDA	getJDA()	The JDA instance of this Presence
OnlineStatus	getStatus()	The current OnlineStatus for this session.
boolean	isIdle()	Whether the current session is marked as afk or not.
void	setActivity(Activity game)	Sets the Activity for this session.
PresenceImpl	setCacheActivity(Activity game)
PresenceImpl	setCacheIdle(boolean idle)
PresenceImpl	setCacheStatus(OnlineStatus status)
void	setIdle(boolean idle)	Sets whether this session should be marked as afk or not
void	setPresence(Activity game, boolean idle)	Sets two presence fields of this session.
void	setPresence(OnlineStatus status, boolean idle)	Sets two presence fields of this session.
void	setPresence(OnlineStatus status, Activity activity)	Sets two presence fields of this session.
void	setPresence(OnlineStatus status, Activity activity, boolean idle)	Sets all presence fields of this session.
void	setStatus(OnlineStatus status)	Sets the OnlineStatus for this session

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PresenceImpl

public PresenceImpl(JDAImpl jda)

Creates a new Presence representation for the provided JDAImpl instance

Parameters:

jda - The not-null JDAImpl instance to use

Method Details

getJDA

@Nonnull
public JDA getJDA()

Description copied from interface: Presence

The JDA instance of this Presence

Specified by:

getJDA in interface Presence

Returns:

The current JDA instance

getStatus

@Nonnull
public OnlineStatus getStatus()

Description copied from interface: Presence

The current OnlineStatus for this session.
This might not be what the Discord Client displays due to session clashing!

Specified by:

getStatus in interface Presence

Returns:

The OnlineStatus of the current session

getActivity

public Activity getActivity()

Description copied from interface: Presence

The current Activity for this session.
This might not be what the Discord Client displays due to session clashing!

Specified by:

getActivity in interface Presence

Returns:

The Activity of the current session or null if no activity is set

isIdle

public boolean isIdle()

Description copied from interface: Presence

Whether the current session is marked as afk or not.

This is relevant to client accounts to monitor whether new messages should trigger mobile push-notifications.

Specified by:

isIdle in interface Presence

Returns:

True if this session is marked as afk

setStatus

public void setStatus(OnlineStatus status)

Description copied from interface: Presence

Sets the OnlineStatus for this session

Specified by:

setStatus in interface Presence

Parameters:

status - the OnlineStatus to be used (OFFLINE/null -> INVISIBLE)

setActivity

public void setActivity(Activity game)

Description copied from interface: Presence

Sets the Activity for this session.
An Activity can be retrieved via Activity.playing(String). For streams you provide a valid streaming url as second parameter

Examples:
presence.setActivity(Activity.playing("Thrones"));
presence.setActivity(Activity.streaming("Thrones", "https://twitch.tv/EasterEggs"));

Specified by:

setActivity in interface Presence

Parameters:

game - An Activity instance or null to reset

See Also:

• Activity.playing(String)
• Activity.streaming(String, String)

setIdle

public void setIdle(boolean idle)

Description copied from interface: Presence

Sets whether this session should be marked as afk or not

This is relevant to client accounts to monitor whether new messages should trigger mobile push-notifications.

Specified by:

setIdle in interface Presence

Parameters:

idle - boolean

setPresence

public void setPresence(OnlineStatus status,
 Activity activity,
 boolean idle)

Description copied from interface: Presence

Sets all presence fields of this session.

Specified by:

setPresence in interface Presence

Parameters:

status - The OnlineStatus for this session (See Presence.setStatus(OnlineStatus))

activity - The Activity for this session (See Presence.setActivity(net.dv8tion.jda.api.entities.Activity) for more info)

idle - Whether to mark this session as idle (useful for client accounts Presence.setIdle(boolean))

setPresence

public void setPresence(OnlineStatus status,
 Activity activity)

Description copied from interface: Presence

Sets two presence fields of this session.
The third field stays untouched.

Specified by:

setPresence in interface Presence

Parameters:

status - The OnlineStatus for this session (See Presence.setStatus(OnlineStatus))

activity - The Activity for this session (See Presence.setActivity(net.dv8tion.jda.api.entities.Activity) for more info)

setPresence

public void setPresence(OnlineStatus status,
 boolean idle)

Description copied from interface: Presence

Sets two presence fields of this session.
The third field stays untouched.

Specified by:

setPresence in interface Presence

Parameters:

status - The OnlineStatus for this session (See Presence.setStatus(OnlineStatus))

idle - Whether to mark this session as idle (useful for client accounts Presence.setIdle(boolean))

setPresence

public void setPresence(Activity game,
 boolean idle)

Description copied from interface: Presence

Sets two presence fields of this session.
The third field stays untouched.

Specified by:

setPresence in interface Presence

Parameters:

game - The Activity for this session (See Presence.setActivity(net.dv8tion.jda.api.entities.Activity) for more info)

idle - Whether to mark this session as idle (useful for client accounts Presence.setIdle(boolean))

setCacheStatus

public PresenceImpl setCacheStatus(OnlineStatus status)

setCacheActivity

public PresenceImpl setCacheActivity(Activity game)

setCacheIdle

public PresenceImpl setCacheIdle(boolean idle)

getFullPresence

public DataObject getFullPresence()

getGameJson

public static DataObject getGameJson(Activity activity)