club.minnced.discord.rpc

Interface DiscordRPC

All Superinterfaces:

com.sun.jna.Library

public interface DiscordRPC
extends com.sun.jna.Library

Core library binding for the official Discord RPC SDK.
Use INSTANCE to access this library.

Supported Architectures

• Windows x86
• Windows x86-64
• Linux x86-64
• Darwin

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISCORD_REPLY_IGNORE Currently unsused response, treated like NO.
static int	DISCORD_REPLY_NO Used to decline a request via Discord_Respond(String, int)
static int	DISCORD_REPLY_YES Used to accept a request via Discord_Respond(String, int)
static DiscordRPC	INSTANCE Library instance.

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_SYMBOL_PROVIDER, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
void	Discord_ClearPresence() Clears the currently set presence.
void	Discord_Initialize(@NotNull java.lang.String applicationId, @Nullable DiscordEventHandlers handlers, boolean autoRegister, @Nullable java.lang.String steamId) Initializes the library, supply with application details and event handlers.
void	Discord_Register(java.lang.String applicationId, java.lang.String command) Registers the given application so it can be run by the discord client.
void	Discord_RegisterSteamGame(java.lang.String applicationId, java.lang.String steamId) Similar to Discord_Register(String, String) but uses the steam game's installation path.
void	Discord_Respond(@NotNull java.lang.String userid, int reply) Responds to the given user with the specified reply type.
void	Discord_RunCallbacks() Executes the registered handlers for currently queued events.
void	Discord_Shutdown() Shuts the RPC connection down.
void	Discord_UpdateConnection() Polls events from the RPC pipe and pushes the currently queued presence.
void	Discord_UpdateHandlers(@Nullable DiscordEventHandlers handlers) Updates the registered event handlers to the provided struct.
void	Discord_UpdatePresence(@Nullable DiscordRichPresence struct) Updates the currently set presence of the logged in user.

Field Detail

INSTANCE

static final DiscordRPC INSTANCE

Library instance.

DISCORD_REPLY_NO

static final int DISCORD_REPLY_NO

Used to decline a request via Discord_Respond(String, int)

See Also:

DISCORD_REPLY_YES, Constant Field Values

DISCORD_REPLY_YES

static final int DISCORD_REPLY_YES

Used to accept a request via Discord_Respond(String, int)

See Also:

DISCORD_REPLY_NO, Constant Field Values

DISCORD_REPLY_IGNORE

static final int DISCORD_REPLY_IGNORE

Currently unsused response, treated like NO. Used with Discord_Respond(String, int)

See Also:

DISCORD_REPLY_NO, Constant Field Values

Method Detail

Discord_Initialize

void Discord_Initialize(@NotNull
                        @NotNull java.lang.String applicationId,
                        @Nullable
                        @Nullable DiscordEventHandlers handlers,
                        boolean autoRegister,
                        @Nullable
                        @Nullable java.lang.String steamId)

Initializes the library, supply with application details and event handlers. Handlers are only called when the Discord_RunCallbacks() method is invoked!
Before closing the application it is recommended to call Discord_Shutdown()

Parameters:

applicationId - The ID for this RPC application, retrieved from the developer dashboard

handlers - Nullable instance of DiscordEventHandlers

autoRegister - true to automatically call Discord_RegisterSteamGame(String, String) or Discord_Register(String, String)

steamId - Possible steam ID of the running game

Discord_Shutdown

void Discord_Shutdown()

Shuts the RPC connection down. If not currently connected, this does nothing.

Discord_RunCallbacks

void Discord_RunCallbacks()

Executes the registered handlers for currently queued events.
If this is not called the handlers will not receive any events!

It is recommended to call this in a 2 second interval

Discord_UpdateConnection

void Discord_UpdateConnection()

Polls events from the RPC pipe and pushes the currently queued presence.
This will be performed automatically if the attached binary has an enabled IO thread (default)

If the IO-Thread has been enabled this will not be supported!

Discord_UpdatePresence

void Discord_UpdatePresence(@Nullable
                            @Nullable DiscordRichPresence struct)

Updates the currently set presence of the logged in user.
Note that the client only updates its presence every 15 seconds and queues all additional presence updates.

Parameters:

struct - The new presence to use

See Also:

DiscordRichPresence

Discord_ClearPresence

void Discord_ClearPresence()

Clears the currently set presence.

Discord_Respond

void Discord_Respond(@NotNull
                     @NotNull java.lang.String userid,
                     int reply)

Responds to the given user with the specified reply type.

Possible Replies

• DISCORD_REPLY_NO
• DISCORD_REPLY_YES
• DISCORD_REPLY_IGNORE

Parameters:

userid - The id of the user to respond to

reply - The reply type

See Also:

DiscordUser.userId

Discord_UpdateHandlers

void Discord_UpdateHandlers(@Nullable
                            @Nullable DiscordEventHandlers handlers)

Updates the registered event handlers to the provided struct.

Parameters:

handlers - The handlers to update to, or null

Discord_Register

void Discord_Register(java.lang.String applicationId,
                      java.lang.String command)

Registers the given application so it can be run by the discord client. discord-<appid>://

Parameters:

applicationId - The ID of the application to register

command - The command for the application startup, or null to use the current executable's path

Discord_RegisterSteamGame

void Discord_RegisterSteamGame(java.lang.String applicationId,
                               java.lang.String steamId)

Similar to Discord_Register(String, String) but uses the steam game's installation path.

Parameters:

applicationId - The ID of the application to register

steamId - The steam ID for the game