Package de.jcm.discordgamesdk

Class OverlayManager

java.lang.Object

de.jcm.discordgamesdk.OverlayManager

public class OverlayManager
extends Object

Manager to control Discord's game overlay.

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay

Method Summary

Modifier and Type	Method	Description
boolean	isEnabled()	Checks if the overlay is enabled by the user.
boolean	isLocked()	Checks if the overlay is locked.
void	openActivityInvite(ActivityActionType type)	Opens the overlay and prepares a join/spectate invitation to send.
void	openActivityInvite(ActivityActionType type, Consumer<Result> callback)	Opens the overlay and prepares a join/spectate invitation to send.
void	openGuildInvite(String code)	Opens the overlay and attempts to join a guild with an invite code.
void	openGuildInvite(String code, Consumer<Result> callback)	Opens the overlay and attempts to join a guild with an invite code.
void	openVoiceSettings()	Opens the overlay and shows a widget to adjust the user's application specific voice settings.
void	openVoiceSettings(Consumer<Result> callback)	Opens the overlay and shows a widget to adjust the user's application specific voice settings.
void	setLocked(boolean locked)	Changes the locked status of the overlay.
void	setLocked(boolean locked, Consumer<Result> callback)	Changes the locked status of the overlay.

Methods inherited from class java.lang.Object

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

Method Details

isEnabled

public boolean isEnabled()

Checks if the overlay is enabled by the user.

Returns:

true if the overlay is enabled

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#isenabled

isLocked

public boolean isLocked()

Checks if the overlay is locked.

Returns:

true if the overlay is locked

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#islocked

setLocked

public void setLocked(boolean locked)

Changes the locked status of the overlay.

The Core.DEFAULT_CALLBACK is used to handle the returned Result.

Parameters:

locked - New locked status

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#setlocked

setLocked

public void setLocked(boolean locked,
 Consumer<Result> callback)

Changes the locked status of the overlay.

A custom callback is used to handle the returned Result.

Parameters:

locked - New locked status

callback - Callback to process the returned Result.

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#setlocked

openActivityInvite

public void openActivityInvite(ActivityActionType type)

Opens the overlay and prepares a join/spectate invitation to send.

The Core.DEFAULT_CALLBACK is used to handle the returned Result.

Parameters:

type - Type of the invitation

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#openactivityinvite

openActivityInvite

public void openActivityInvite(ActivityActionType type,
 Consumer<Result> callback)

Opens the overlay and prepares a join/spectate invitation to send.

A custom callback is used to handle the returned Result.

Parameters:

type - Type of the invitation

callback - Callback to process the returned Result.

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#openactivityinvite

openGuildInvite

public void openGuildInvite(String code)

Opens the overlay and attempts to join a guild with an invite code.

The Core.DEFAULT_CALLBACK is used to handle the returned Result.

Parameters:

code - Invite code for a guild

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#openguildinvite

openGuildInvite

public void openGuildInvite(String code,
 Consumer<Result> callback)

Opens the overlay and attempts to join a guild with an invite code.

A custom callback is used to handle the returned Result.

Parameters:

code - Invite code for a guild

callback - Callback to process the returned Result.

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#openguildinvite

openVoiceSettings

public void openVoiceSettings()

Opens the overlay and shows a widget to adjust the user's application specific voice settings.

The Core.DEFAULT_CALLBACK is used to handle the returned Result.

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#openvoicesettings

openVoiceSettings

public void openVoiceSettings(Consumer<Result> callback)

Opens the overlay and shows a widget to adjust the user's application specific voice settings.

A custom callback is used to handle the returned Result.

Parameters:

callback - Callback to process the returned Result.

See Also:

• https://discordapp.com/developers/docs/game-sdk/overlay#openvoicesettings