Package net.runelite.client.discord

Class DiscordPresence.DiscordPresenceBuilder

java.lang.Object

net.runelite.client.discord.DiscordPresence.DiscordPresenceBuilder

Enclosing class:

DiscordPresence

public static class DiscordPresence.DiscordPresenceBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
DiscordPresence	build()
DiscordPresence.DiscordPresenceBuilder	details(String details)	What the player is currently doing.
DiscordPresence.DiscordPresenceBuilder	endTimestamp(Instant endTimestamp)	Unix timestamp (seconds) for the end of the game.
DiscordPresence.DiscordPresenceBuilder	instance(boolean instance)	Marks the matchSecret as a game session with a specific beginning and end.
DiscordPresence.DiscordPresenceBuilder	joinSecret(String joinSecret)	Unique hashed string for Spectate button.
DiscordPresence.DiscordPresenceBuilder	largeImageKey(String largeImageKey)	Name of the uploaded image for the large profile artwork.
DiscordPresence.DiscordPresenceBuilder	largeImageText(String largeImageText)	Tooltip for the largeImageKey.
DiscordPresence.DiscordPresenceBuilder	matchSecret(String matchSecret)	Unique hashed string for Spectate and Join.
DiscordPresence.DiscordPresenceBuilder	partyId(String partyId)	ID of the player's party, lobby, or group.
DiscordPresence.DiscordPresenceBuilder	partyMax(int partyMax)	Maximum size of the player's party, lobby, or group.
DiscordPresence.DiscordPresenceBuilder	partySize(int partySize)	Current size of the player's party, lobby, or group.
DiscordPresence.DiscordPresenceBuilder	smallImageKey(String smallImageKey)	Name of the uploaded image for the small profile artwork.
DiscordPresence.DiscordPresenceBuilder	smallImageText(String smallImageText)	Tooltip for the smallImageKey.
DiscordPresence.DiscordPresenceBuilder	spectateSecret(String spectateSecret)	Unique hashed string for chat invitations and Ask to Join.
DiscordPresence.DiscordPresenceBuilder	startTimestamp(Instant startTimestamp)	Unix timestamp (seconds) for the start of the game.
DiscordPresence.DiscordPresenceBuilder	state(String state)	The user's current party status.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

state

public DiscordPresence.DiscordPresenceBuilder state(String state)

The user's current party status. Example: "Looking to Play", "Playing Solo", "In a Group" Maximum: 128 characters

Returns:

this.

details

public DiscordPresence.DiscordPresenceBuilder details(String details)

What the player is currently doing. Example: "Competitive - Captain's Mode", "In Queue", "Unranked PvP" Maximum: 128 characters

Returns:

this.

startTimestamp

public DiscordPresence.DiscordPresenceBuilder startTimestamp(Instant startTimestamp)

Unix timestamp (seconds) for the start of the game.

Returns:

this.

endTimestamp

public DiscordPresence.DiscordPresenceBuilder endTimestamp(Instant endTimestamp)

Unix timestamp (seconds) for the end of the game.

Returns:

this.

largeImageKey

public DiscordPresence.DiscordPresenceBuilder largeImageKey(String largeImageKey)

Name of the uploaded image for the large profile artwork. Example: "default" Maximum: 32 characters

Returns:

this.

largeImageText

public DiscordPresence.DiscordPresenceBuilder largeImageText(String largeImageText)

Tooltip for the largeImageKey. Example: "Blade's Edge Arena", "Numbani", "Danger Zone" Maximum: 128 characters

Returns:

this.

smallImageKey

public DiscordPresence.DiscordPresenceBuilder smallImageKey(String smallImageKey)

Name of the uploaded image for the small profile artwork. Example: "rogue" Maximum: 32 characters

Returns:

this.

smallImageText

public DiscordPresence.DiscordPresenceBuilder smallImageText(String smallImageText)

Tooltip for the smallImageKey. Example: "Rogue - Level 100" Maximum: 128 characters

Returns:

this.

partyId

public DiscordPresence.DiscordPresenceBuilder partyId(String partyId)

ID of the player's party, lobby, or group. Example: "ae488379-351d-4a4f-ad32-2b9b01c91657" Maximum: 128 characters

Returns:

this.

partySize

public DiscordPresence.DiscordPresenceBuilder partySize(int partySize)

Current size of the player's party, lobby, or group. Example: 1

Returns:

this.

partyMax

public DiscordPresence.DiscordPresenceBuilder partyMax(int partyMax)

Maximum size of the player's party, lobby, or group. Example: 5

Returns:

this.

matchSecret

public DiscordPresence.DiscordPresenceBuilder matchSecret(String matchSecret)

Unique hashed string for Spectate and Join. Required to enable match interactive buttons in the user's presence. Example: "MmhuZToxMjMxMjM6cWl3amR3MWlqZA==" Maximum: 128 characters

Returns:

this.

joinSecret

public DiscordPresence.DiscordPresenceBuilder joinSecret(String joinSecret)

Unique hashed string for Spectate button. This will enable the "Spectate" button on the user's presence if whitelisted. Example: "MTIzNDV8MTIzNDV8MTMyNDU0" Maximum: 128 characters

Returns:

this.

spectateSecret

public DiscordPresence.DiscordPresenceBuilder spectateSecret(String spectateSecret)

Unique hashed string for chat invitations and Ask to Join. This will enable the "Ask to Join" button on the user's presence if whitelisted. Example: "MTI4NzM0OjFpMmhuZToxMjMxMjM=" Maximum: 128 characters

Returns:

this.

instance

public DiscordPresence.DiscordPresenceBuilder instance(boolean instance)

Marks the matchSecret as a game session with a specific beginning and end.

Returns:

this.

build

public DiscordPresence build()

toString

public String toString()

Overrides:

toString in class Object