Package ovh.mythmc.social.api.user

Class AbstractSocialUser

java.lang.Object

ovh.mythmc.social.api.user.AbstractSocialUser

All Implemented Interfaces:

Audience, ForwardingAudience, ForwardingAudience.Single, Pointered, ChatParticipant, Identified, CompanionClient, OnlinePresence, Reactable, SocialUser, UserPreferences

Direct Known Subclasses:

BukkitSocialUser, ConsoleSocialUser

public abstract class AbstractSocialUser
extends Object
implements SocialUser

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience

ForwardingAudience.Single

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<String>	blockedChannelNames
protected SocialUserCompanion	companion
protected final Mutable<TextComponent>	displayName
protected final Mutable<Long>	lastMessageTimestamp
protected final Mutable<UUID>	lastPrivateMessageRecipient
protected final Mutable<ChatChannel>	mainChannel
protected final Class<? extends SocialUser>	rendererClass
protected final Mutable<Boolean>	socialSpy
protected final String	username
protected final UUID	uuid

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSocialUser(@NotNull UUID uuid, @NotNull String username, @NotNull Class<? extends SocialUser> rendererClass)

Method Summary

Modifier and Type	Method	Description
@NotNull Set<String>	blockedChannels()	Returns the set of channel names that this participant has blocked.
@NotNull Optional<SocialUserCompanion>	companion()	Gets the optional SocialUserCompanion instance of this user.
@NotNull Mutable<TextComponent>	displayName()	Gets the Mutable display name of this user.
@NotNull Optional<GroupChatChannel>	groupChannel()	Gets the group chat channel the participant is currently part of, if any.
boolean	isExpired()	Determines whether this entity should be removed from cache.
@NotNull Mutable<Long>	lastMessageTimestamp()	Gets the timestamp of the last message sent by this user.
@NotNull Mutable<UUID>	lastPrivateMessageRecipient()	Gets the last participant to whom this user sent a private message.
@NotNull Mutable<ChatChannel>	mainChannel()	Gets the participant's main chat channel.
void	playReaction(@NotNull Reaction reaction)	Plays or triggers the specified Reaction.
Class<? extends SocialUser>	rendererClass()	Gets the Class that SocialChatRenderer will use as a reference to render messages.
@NotNull Mutable<Boolean>	socialSpy()	Gets the status of the spy feature for this user.
@NotNull String	username()	Returns the username associated with this identity.
@NotNull UUID	uuid()	Returns the unique identifier of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.adventure.audience.Audience

deleteMessage, openBook, removeResourcePacks, removeResourcePacks, removeResourcePacks, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, showTitle, stopSound

Methods inherited from interface ovh.mythmc.social.api.network.CompanionClient

sendCustomPayload

Methods inherited from interface net.kyori.adventure.audience.ForwardingAudience.Single

audience, audiences, clearResourcePacks, clearTitle, deleteMessage, filterAudience, forEachAudience, get, getOrDefault, getOrDefaultFrom, hideBossBar, openBook, playSound, playSound, playSound, pointers, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendTitlePart, showBossBar, stopSound

Methods inherited from interface ovh.mythmc.social.api.presence.OnlinePresence

isOnline

Methods inherited from interface ovh.mythmc.social.api.user.SocialUser

checkPermission, displayNameOrUsername, sendParsableMessage, sendParsableMessage, sendParsableMessage, sendParsableMessage, sendParsableMessage, sendParsableMessage

Field Details

uuid

protected final UUID uuid

username

protected final String username

rendererClass

protected final Class<? extends SocialUser> rendererClass

blockedChannelNames

protected final Set<String> blockedChannelNames

displayName

protected final Mutable<TextComponent> displayName

mainChannel

protected final Mutable<ChatChannel> mainChannel

socialSpy

protected final Mutable<Boolean> socialSpy

lastMessageTimestamp

protected final Mutable<Long> lastMessageTimestamp

lastPrivateMessageRecipient

protected final Mutable<UUID> lastPrivateMessageRecipient

companion

protected volatile SocialUserCompanion companion

Constructor Details

AbstractSocialUser

protected AbstractSocialUser(@NotNull
 @NotNull UUID uuid,
 @NotNull
 @NotNull String username,
 @NotNull
 @NotNull Class<? extends SocialUser> rendererClass)

Method Details

mainChannel

@NotNull
public @NotNull Mutable<ChatChannel> mainChannel()

Description copied from interface: ChatParticipant

Gets the participant's main chat channel.

This is wrapped in Mutable so the main channel can be changed dynamically.

Specified by:

mainChannel in interface ChatParticipant

Returns:

a Mutable containing the current ChatChannel

groupChannel

@NotNull
public @NotNull Optional<GroupChatChannel> groupChannel()

Description copied from interface: ChatParticipant

Gets the group chat channel the participant is currently part of, if any.

Specified by:

groupChannel in interface ChatParticipant

Returns:

an Optional containing the GroupChatChannel, or empty if not in a group

uuid

@NotNull
public @NotNull UUID uuid()

Description copied from interface: Identified

Returns the unique identifier of this object.

Specified by:

uuid in interface Identified

Returns:

the UUID representing this identity

username

@NotNull
public @NotNull String username()

Description copied from interface: Identified

Returns the username associated with this identity.

Specified by:

username in interface Identified

Returns:

the username

displayName

@NotNull
public @NotNull Mutable<TextComponent> displayName()

Description copied from interface: UserPreferences

Gets the Mutable display name of this user.

Specified by:

displayName in interface UserPreferences

Returns:

a Mutable containing the display name of this user in the form of a TextComponent

companion

@NotNull
public @NotNull Optional<SocialUserCompanion> companion()

Description copied from interface: CompanionClient

Gets the optional SocialUserCompanion instance of this user.

Specified by:

companion in interface CompanionClient

Returns:

an Optional containing the SocialUserCompanion instance of this user, or an empty Optional otherwise

isExpired

public boolean isExpired()

Description copied from interface: OnlinePresence

Determines whether this entity should be removed from cache.

Specified by:

isExpired in interface OnlinePresence

Returns:

true if the entity can be cleared from cache, false otherwise

playReaction

public void playReaction(@NotNull
 @NotNull Reaction reaction)

Description copied from interface: Reactable

Plays or triggers the specified Reaction.

The exact behavior depends on the implementation and may include visual, auditory, or other interactive effects.

Specified by:

playReaction in interface Reactable

Parameters:

reaction - the reaction to play

socialSpy

@NotNull
public @NotNull Mutable<Boolean> socialSpy()

Description copied from interface: UserPreferences

Gets the status of the spy feature for this user.

Specified by:

socialSpy in interface UserPreferences

Returns:

a Mutable containing a Boolean

lastMessageTimestamp

@NotNull
public @NotNull Mutable<Long> lastMessageTimestamp()

Description copied from interface: UserPreferences

Gets the timestamp of the last message sent by this user.

Specified by:

lastMessageTimestamp in interface UserPreferences

Returns:

a Mutable containing the timestamp of the last message sent by this user in the form of a Long

lastPrivateMessageRecipient

@NotNull
public @NotNull Mutable<UUID> lastPrivateMessageRecipient()

Description copied from interface: ChatParticipant

Gets the last participant to whom this user sent a private message.

This is wrapped in Mutable so it can be updated whenever a private message is sent.

Specified by:

lastPrivateMessageRecipient in interface ChatParticipant

Returns:

a Mutable containing the UUID of the last private message recipient

blockedChannels

@NotNull
public @NotNull Set<String> blockedChannels()

Description copied from interface: ChatParticipant

Returns the set of channel names that this participant has blocked.

Blocked channels are those whose messages the participant will not receive.

Specified by:

blockedChannels in interface ChatParticipant

Returns:

an immutable Set of blocked channel IDs

rendererClass

public Class<? extends SocialUser> rendererClass()

Description copied from interface: SocialUser

Gets the Class that SocialChatRenderer will use as a reference to render messages.

Specified by:

rendererClass in interface SocialUser

Returns:

the Class subtype of SocialUser to use as a reference for the renderer