Package ovh.mythmc.social.api.user

Class SocialUserManager

java.lang.Object

ovh.mythmc.social.api.user.SocialUserManager

public class SocialUserManager
extends Object

This class provides various user-related utilities.

Most methods in this class are used internally and shouldn't be used by external plugins unless necessary.

Field Summary

Fields

Modifier and Type	Field	Description
static final SocialUserManager	instance

Constructor Summary

Constructors

Constructor	Description
SocialUserManager()

Method Summary

Modifier and Type	Method	Description
void	announceChannelSwitch(@NotNull SocialUser user, @NotNull ChatChannel channel)	Announces a ChatChannel switch to the SocialUser and switches their main channel afterwards.
void	disableCompanion(@NotNull SocialUser user)	Disables the companion mod features for a specific SocialUser.
void	enableCompanion(@NotNull SocialUser user)	Enables the companion mod features for a specific SocialUser.
boolean	isGloballyMuted(@NotNull SocialUser user)	Checks if a SocialUser is muted across all channels.
boolean	isMuted(@NotNull SocialUser user, @NotNull ChatChannel channel)	Checks if a SocialUser is muted in a specific ChatChannel.
void	mute(@NotNull SocialUser user, @NotNull ChatChannel channel)	Mutes a SocialUser in a specific ChatChannel.
void	unmute(@NotNull SocialUser user, @NotNull ChatChannel channel)	Unmutes a SocialUser in a specific ChatChannel.

Methods inherited from class java.lang.Object

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

Field Details

instance

public static final SocialUserManager instance

Constructor Details

SocialUserManager

public SocialUserManager()

Method Details

announceChannelSwitch

public void announceChannelSwitch(@NotNull
 @NotNull SocialUser user,
 @NotNull
 @NotNull ChatChannel channel)

Announces a ChatChannel switch to the SocialUser and switches their main channel afterwards.

Parameters:

user - the SocialUser to send the message to

channel - the ChatChannel to switch to

isGloballyMuted

public boolean isGloballyMuted(@NotNull
 @NotNull SocialUser user)

Checks if a SocialUser is muted across all channels.

Parameters:

user - the SocialUser to check

Returns:

true if the SocialUser is muted globally, false otherwise

isMuted

public boolean isMuted(@NotNull
 @NotNull SocialUser user,
 @NotNull
 @NotNull ChatChannel channel)

Checks if a SocialUser is muted in a specific ChatChannel.

Parameters:

user - the SocialUser to check

channel - the ChatChannel to check

Returns:

true if the SocialUser is muted in ChatChannel, false otherwise

mute

public void mute(@NotNull
 @NotNull SocialUser user,
 @NotNull
 @NotNull ChatChannel channel)

Mutes a SocialUser in a specific ChatChannel.

Parameters:

user - the SocialUser to mute

channel - the ChatChannel where the user will be muted

unmute

public void unmute(@NotNull
 @NotNull SocialUser user,
 @NotNull
 @NotNull ChatChannel channel)

Unmutes a SocialUser in a specific ChatChannel.

Parameters:

user - the SocialUser to unmuet

channel - the ChatChannel where the user will be unmuted

enableCompanion

public void enableCompanion(@NotNull
 @NotNull SocialUser user)

Enables the companion mod features for a specific SocialUser.

Parameters:

user - the SocialUser to enable the companion features for

disableCompanion

public void disableCompanion(@NotNull
 @NotNull SocialUser user)

Disables the companion mod features for a specific SocialUser.

Parameters:

user - the SocialUser to disable the companion features for