Package discord4j.core.object.presence

Class Presence

java.lang.Object

discord4j.core.object.presence.Presence

public final class Presence
extends Object

Presence is the current state of a user on a guild, received from Discord.

This is as opposed to ClientPresence which is sent to Discord.

A presence includes a user's activities and their current status on a given platform.

See Also:

Presence

Constructor Summary

Constructors

Constructor	Description
Presence(discord4j.discordjson.json.PresenceData data)

Method Summary

Modifier and Type	Method	Description
List<Activity>	getActivities()	Get the user's current activities.
Optional<Activity>	getActivity()	Get a user's current activity, if present.
Status	getStatus()	Get the user's status.
Optional<Status>	getStatus(Status.Platform platform)	Get the user's status for the given platform, if present.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Presence

public Presence(discord4j.discordjson.json.PresenceData data)

Method Detail

getStatus

public Status getStatus()

Get the user's status.

Returns:

The user's status.

getStatus

public Optional<Status> getStatus(Status.Platform platform)

Get the user's status for the given platform, if present.

Parameters:

platform - the platform to obtain a user status

Returns:

an Optional with the user's status for a given platform, or empty if not present.

getActivity

public Optional<Activity> getActivity()

Get a user's current activity, if present.

Returns:

an Optional with the user's activity, or empty if not present.

getActivities

public List<Activity> getActivities()

Get the user's current activities.

Returns:

The user's current activities.

toString

public String toString()

Overrides:

toString in class Object