Package net.dv8tion.jda.api.entities

Interface Activity

All Known Subinterfaces:

RichPresence

public interface Activity

Represents a Discord Activity.
This should contain all information provided from Discord about a Activity.

Since:

2.1

Author:

John A. Grosh

See Also:

of(ActivityType, String), of(ActivityType, String, String), playing(String), watching(String), listening(String), streaming(String, String), competing(String)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Activity.ActivityType	The activity being executed, differentiating between, amongst others, playing, listening and streaming.
static class	Activity.Emoji	Emoji for a custom status.
static class	Activity.Timestamps	Represents the start and end timestamps for a running match

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	STREAMING_URL	The Pattern used for isValidStreamingUrl(String)

Method Summary

Modifier and Type	Method	Description
RichPresence	asRichPresence()	RichPresence representation of this Activity.
static Activity	competing(String name)	Creates a new Activity instance with the specified name.
Activity.Emoji	getEmoji()	The emoji (or custom emoji) attached to a custom status.
String	getName()	The displayed name of the Activity.
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.
boolean	isRich()	Whether this is a Rich Presence If false the result of asRichPresence() is null
static boolean	isValidStreamingUrl(String url)	Checks if a given String is a valid Twitch/Youtube streaming url (ie, one that will display "Streaming" on the Discord client).
static Activity	listening(String name)	Creates a new Activity instance with the specified name.
static Activity	of(Activity.ActivityType type, String name)	Creates a new Activity instance with the specified name.
static Activity	of(Activity.ActivityType type, String name, String url)	Creates a new Activity instance with the specified name and url.
static Activity	playing(String name)	Creates a new Activity instance with the specified name.
static Activity	streaming(String name, String url)	Creates a new Activity instance with the specified name and url.
static Activity	watching(String name)	Creates a new Activity instance with the specified name.

Field Detail

STREAMING_URL

static final Pattern STREAMING_URL

The Pattern used for isValidStreamingUrl(String)

Method Detail

isRich

boolean isRich()

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

Returns:

true if this is a RichPresence

asRichPresence

@Nullable
RichPresence asRichPresence()

RichPresence representation of this Activity.

Returns:

RichPresence or null if isRich() returns false

getName

@Nonnull
String getName()

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

Returns:

String containing the Activity's name.

getUrl

@Nullable
String getUrl()

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

Returns:

Possibly-null String containing the Activity's URL.

getType

@Nonnull
Activity.ActivityType getType()

The type of Activity.

Returns:

Never-null ActivityType representing the type of Activity

getTimestamps

@Nullable
Activity.Timestamps getTimestamps()

Information on the match duration, start, and end.

Returns:

Timestamps wrapper of null if unset

getEmoji

@Nullable
Activity.Emoji getEmoji()

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

Returns:

Possibly-null Activity.Emoji used for custom status

playing

@Nonnull
static Activity playing(@Nonnull
                        String name)

Creates a new Activity instance with the specified name.
In order to appear as "streaming" in the official client you must provide a valid (see documentation of method) streaming URL in Activity.streaming(String, String).

Parameters:

name - The not-null name of the newly created game

Returns:

A valid Activity instance with the provided name with Activity.ActivityType.PLAYING

Throws:

IllegalArgumentException - if the specified name is null, empty, blank or longer than 128 characters

streaming

@Nonnull
static Activity streaming(@Nonnull
                          String name,
                          @Nullable
                          String url)

Creates a new Activity instance with the specified name and url.
The specified URL must be valid according to discord standards in order to display as "streaming" in the official client. A valid streaming URL must be derived from https://twitch.tv/ or https://youtube.com/watch?v= and can be verified using isValidStreamingUrl(String). (see documentation)

Parameters:

name - The not-null name of the newly created game

url - The streaming url to use, required to display as "streaming"

Returns:

A valid Activity instance with the provided name and url

Throws:

IllegalArgumentException - If the specified name is null, empty or longer than 128 characters

See Also:

isValidStreamingUrl(String)

listening

@Nonnull
static Activity listening(@Nonnull
                          String name)

Creates a new Activity instance with the specified name.
This will display as Listening name in the official client

Parameters:

name - The not-null name of the newly created game

Returns:

A valid Activity instance with the provided name with Activity.ActivityType.LISTENING

Throws:

IllegalArgumentException - if the specified name is null, empty, blank or longer than 128 characters

watching

@Nonnull
@Incubating
static Activity watching(@Nonnull
                         String name)

Creates a new Activity instance with the specified name.
This will display as Watching name in the official client

Parameters:

name - The not-null name of the newly created game

Returns:

A valid Activity instance with the provided name with Activity.ActivityType.WATCHING

Throws:

IllegalArgumentException - if the specified name is null, empty, blank or longer than 128 characters

Incubating:

This feature is not yet confirmed for the official bot API

competing

@Nonnull
static Activity competing(@Nonnull
                          String name)

Creates a new Activity instance with the specified name.
This will display as Competing in name in the official client

Parameters:

name - The not-null name of the newly created game

Returns:

A valid Activity instance with the provided name with Activity.ActivityType.COMPETING

Throws:

IllegalArgumentException - If the specified name is null, empty, blank or longer than 128 characters

Since:

4.2.1

of

@Nonnull
static Activity of(@Nonnull
                   Activity.ActivityType type,
                   @Nonnull
                   String name)

Creates a new Activity instance with the specified name.

Parameters:

type - The ActivityType to use

name - The not-null name of the newly created game

Returns:

A valid Activity instance with the provided name

Throws:

IllegalArgumentException -

• If the specified ActivityType is null or unsupported
• If the specified name is null, empty or longer than 128 characters

of

@Nonnull
static Activity of(@Nonnull
                   Activity.ActivityType type,
                   @Nonnull
                   String name,
                   @Nullable
                   String url)

Creates a new Activity instance with the specified name and url.
The provided url would only be used for ActivityType.STREAMING and should be a twitch url.

Parameters:

type - The ActivityType to use

name - The not-null name of the newly created game

url - The streaming url to use, required to display as "streaming".

Returns:

A valid Activity instance with the provided name and url

Throws:

IllegalArgumentException -

• If the specified ActivityType is null or unsupported
• If the specified name is null, empty or longer than 128 characters

See Also:

isValidStreamingUrl(String)

isValidStreamingUrl

static boolean isValidStreamingUrl(@Nullable
                                   String url)

Checks if a given String is a valid Twitch/Youtube streaming url (ie, one that will display "Streaming" on the Discord client).

Parameters:

url - The url to check.

Returns:

True if the provided url is valid for triggering Discord's streaming status