Package de.jcm.discordgamesdk

Class DiscordEventHandler

java.lang.Object

de.jcm.discordgamesdk.DiscordEventAdapter

de.jcm.discordgamesdk.DiscordEventHandler

public class DiscordEventHandler
extends DiscordEventAdapter

A DiscordEventAdapter that forwards all events to other adapters.

All events are unconditionally forwarded to other DiscordEventAdapters that can be registered and unregistered dynamically.

A CopyOnWriteArrayList is used for increased thread-safety.

See Also:

• DiscordEventAdapter
• addListener(DiscordEventAdapter)
• removeListener(DiscordEventAdapter)
• removeAllListeners()

Constructor Summary

Constructors

Constructor	Description
DiscordEventHandler()

Method Summary

Modifier and Type	Method	Description
void	addListener(DiscordEventAdapter listener)	Registers a new event adapter to forward Discord events to.
void	onActivityJoin(String secret)	Fires when the user attempts to join a game by accepting an invite.
void	onActivityJoinRequest(DiscordUser user)	Fires when a user asked to join the user by using "Ask to join" button.
void	onActivitySpectate(String secret)	Fires when the user attempts to spectate a game by accepting an invite or using the "spectate"-button.
void	onCurrentUserUpdate()	Fires when the current user changes their user information (avatar, username, etc.).
void	onOverlayToggle(boolean locked)	Fires when the overlay is toggled (locked / unlocked).
void	onRelationshipRefresh()	Fires when there is a new cached version of the user's relationships.
void	onRelationshipUpdate(Relationship relationship)	Fires when information about a relationship (also user, presence, etc.) in the filtered list changes.
void	removeAllListeners()	Removes all registered event adapters.
boolean	removeListener(DiscordEventAdapter listener)	Unregisters a event adapter that has been registered before.

Methods inherited from class java.lang.Object

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

Constructor Details

DiscordEventHandler

public DiscordEventHandler()

Method Details

addListener

public void addListener(DiscordEventAdapter listener)

Registers a new event adapter to forward Discord events to.

Parameters:

listener - Any kind of DiscordEventAdapter

See Also:

• removeListener(DiscordEventAdapter)
• CopyOnWriteArrayList.add(Object)

removeListener

public boolean removeListener(DiscordEventAdapter listener)

Unregisters a event adapter that has been registered before.

Parameters:

listener - Any kind of DiscordEventAdapter that has been added before

Returns:

true if the adapter was registered and is now unregisters

See Also:

• addListener(DiscordEventAdapter)
• CopyOnWriteArrayList.remove(Object)

removeAllListeners

public void removeAllListeners()

Removes all registered event adapters.

Until new event adapters are registered, all events are effectively ignored.

See Also:

• CopyOnWriteArrayList.clear()

onActivityJoin

public void onActivityJoin(String secret)

Description copied from class: DiscordEventAdapter

Fires when the user attempts to join a game by accepting an invite.

Overrides:

onActivityJoin in class DiscordEventAdapter

Parameters:

secret - The join or the match secret of the activity

See Also:

• ActivitySecrets.setJoinSecret(String)
• ActivitySecrets.setMatchSecret(String)
• https://discordapp.com/developers/docs/game-sdk/activities#onactivityjoin

onActivitySpectate

public void onActivitySpectate(String secret)

Description copied from class: DiscordEventAdapter

Fires when the user attempts to spectate a game by accepting an invite or using the "spectate"-button.

Overrides:

onActivitySpectate in class DiscordEventAdapter

Parameters:

secret - The spectate secret of the activity

See Also:

• ActivitySecrets.setSpectateSecret(String)
• https://discordapp.com/developers/docs/game-sdk/activities#onactivityspectate

onActivityJoinRequest

public void onActivityJoinRequest(DiscordUser user)

Description copied from class: DiscordEventAdapter

Fires when a user asked to join the user by using "Ask to join" button.

Overrides:

onActivityJoinRequest in class DiscordEventAdapter

Parameters:

user - User that requested to join

See Also:

• https://discordapp.com/developers/docs/game-sdk/activities#onactivityjoinrequest

onCurrentUserUpdate

public void onCurrentUserUpdate()

Description copied from class: DiscordEventAdapter

Fires when the current user changes their user information (avatar, username, etc.).

Also fires after initialization of the UserManager and therefore indicates that UserManager.getCurrentUser() is ready to be called.

Overrides:

onCurrentUserUpdate in class DiscordEventAdapter

See Also:

• https://discordapp.com/developers/docs/game-sdk/users#oncurrentuserupdate

onOverlayToggle

public void onOverlayToggle(boolean locked)

Description copied from class: DiscordEventAdapter

Fires when the overlay is toggled (locked / unlocked).

Apparently also fires after initialization of the OverlayManager and therefore tells you the initial overlay state.

Overrides:

onOverlayToggle in class DiscordEventAdapter

Parameters:

locked - Current state of the overlay

See Also:

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

onRelationshipRefresh

public void onRelationshipRefresh()

Description copied from class: DiscordEventAdapter

Fires when there is a new cached version of the user's relationships.

Also fires after initialization of the RelationshipManager and therefore indicates that its methods can be used to fetch relationship information.

Overrides:

onRelationshipRefresh in class DiscordEventAdapter

See Also:

• https://discordapp.com/developers/docs/game-sdk/relationships#onrefresh

onRelationshipUpdate

public void onRelationshipUpdate(Relationship relationship)

Description copied from class: DiscordEventAdapter

Fires when information about a relationship (also user, presence, etc.) in the filtered list changes.

Overrides:

onRelationshipUpdate in class DiscordEventAdapter

Parameters:

relationship - New relationship information

See Also:

• https://discordapp.com/developers/docs/game-sdk/relationships#onrelationshipupdate