Package net.dv8tion.jda.internal.entities

Class ActivityImpl

java.lang.Object

net.dv8tion.jda.internal.entities.ActivityImpl

All Implemented Interfaces:

Activity

Direct Known Subclasses:

RichPresenceImpl

public class ActivityImpl
extends Object
implements Activity

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Activity

Activity.ActivityType, Activity.Timestamps

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.Activity

MAX_ACTIVITY_NAME_LENGTH, MAX_ACTIVITY_STATE_LENGTH, STREAMING_URL

Method Summary

Modifier and Type	Method	Description
RichPresence	asRichPresence()	RichPresence representation of this Activity.
boolean	equals(Object o)
EmojiUnion	getEmoji()	The emoji (or custom emoji) attached to a custom status.
String	getName()	The displayed name of the Activity.
String	getState()	The user's activity state Example: "Looking to Play", "Playing Solo", "In a Group"
Activity.Timestamps	getTimestamps()	Information on the match duration, start, and end.
Activity.ActivityType	getType()	The type of Activity.
String	getUrl()	The URL of the Activity if the game is actually a Stream.
int	hashCode()
boolean	isRich()	Whether this is a Rich Presence If false the result of Activity.asRichPresence() is null
String	toString()
Activity	withState(String state)	Adds the provided state to the activity.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

isRich

public boolean isRich()

Description copied from interface: Activity

Whether this is a Rich Presence
If false the result of Activity.asRichPresence() is null

Specified by:

isRich in interface Activity

Returns:

true if this is a RichPresence

asRichPresence

public RichPresence asRichPresence()

Description copied from interface: Activity

RichPresence representation of this Activity.

Specified by:

asRichPresence in interface Activity

Returns:

RichPresence or null if Activity.isRich() returns false

getName

@Nonnull
public String getName()

Description copied from interface: Activity

The displayed name of the Activity.
For Activity.ActivityType.CUSTOM_STATUS this will return the custom status text.

Specified by:

getName in interface Activity

Returns:

String containing the Activity's name.

getState

@Nullable
public String getState()

Description copied from interface: Activity

The user's activity state
Example: "Looking to Play", "Playing Solo", "In a Group"

This shows below the normal activity information in the profile.

Example
Code:

 Activity.playing("Trivia")
     .withState("Question 20")
 

Display:

 Playing Trivia
 Question 20
 

Specified by:

getState in interface Activity

Returns:

The user's current party status

getUrl

public String getUrl()

Description copied from interface: Activity

The URL of the Activity if the game is actually a Stream.
This will return null for regular games.

Specified by:

getUrl in interface Activity

Returns:

Possibly-null String containing the Activity's URL.

getType

@Nonnull
public Activity.ActivityType getType()

Description copied from interface: Activity

The type of Activity.

Specified by:

getType in interface Activity

Returns:

Never-null ActivityType representing the type of Activity

getTimestamps

@Nullable
public Activity.Timestamps getTimestamps()

Description copied from interface: Activity

Information on the match duration, start, and end.

Specified by:

getTimestamps in interface Activity

Returns:

Timestamps wrapper of null if unset

getEmoji

@Nullable
public EmojiUnion getEmoji()

Description copied from interface: Activity

The emoji (or custom emoji) attached to a custom status.

Specified by:

getEmoji in interface Activity

Returns:

Possibly-null Emoji used for custom status

withState

@Nonnull
public Activity withState(@Nullable
 String state)

Description copied from interface: Activity

Adds the provided state to the activity.
The state is shown below the activity, unless it is a custom status.

Specified by:

withState in interface Activity

Parameters:

state - The activity state, or null to unset

Returns:

New activity instance with the provided state

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object