Class PrivateChatChannel
java.lang.Object
ovh.mythmc.social.api.chat.channel.PrivateChatChannel
- All Implemented Interfaces:
ChatChannel
-
Nested Class Summary
Nested classes/interfaces inherited from interface ovh.mythmc.social.api.chat.channel.ChatChannel
ChatChannel.ChannelType -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionbooleanAdds the player with the given UUID to this channel.alias()Returns the mutable alias for this channel, if any.color()Returns the primary colour associated with this channel.commands()Returns the slash commands that switch a player into this channel.Returns a short description of this channel shown in menus.protected ChatFormatBuilderstatic PrivateChatChannelgetOrCreate(@NotNull SocialUser sender, @NotNull SocialUser recipient) icon()Returns the icon component shown in menus for this channel.booleanReturnstrueif the player with the given UUID is a member of this channel.booleanReturnstrueif players are automatically added to this channel on join.members()Returns all users currently in this channel.name()Returns the unique name that identifies this channel.Returns the permission node required to see or write in this channel, if any.prefix(@NotNull SocialUser user, @NotNull SocialRegisteredMessageContext message, @NotNull SocialParserContext parser) Builds the rendered prefix shown before each message in this channel.booleanremoveMember(@NotNull UUID uuid) Removes the player with the given UUID from this channel.Returns the renderer features that are active in this channel (e.g. replies, reactions).Returns an optional override colour applied to message text in this channel.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ovh.mythmc.social.api.chat.channel.ChatChannel
addMember, aliasOrName, isMember, removeMember
-
Field Details
-
memberUuids
-
-
Method Details
-
getOrCreate
public static PrivateChatChannel getOrCreate(@NotNull @NotNull SocialUser sender, @NotNull @NotNull SocialUser recipient) -
supportedRendererFeatures
Description copied from interface:ChatChannelReturns the renderer features that are active in this channel (e.g. replies, reactions).- Specified by:
supportedRendererFeaturesin interfaceChatChannel
-
getRecipientForSender
-
name
Description copied from interface:ChatChannelReturns the unique name that identifies this channel.- Specified by:
namein interfaceChatChannel
-
alias
Description copied from interface:ChatChannelReturns the mutable alias for this channel, if any.- Specified by:
aliasin interfaceChatChannel
-
commands
Description copied from interface:ChatChannelReturns the slash commands that switch a player into this channel.- Specified by:
commandsin interfaceChatChannel
-
icon
Description copied from interface:ChatChannelReturns the icon component shown in menus for this channel.- Specified by:
iconin interfaceChatChannel
-
description
Description copied from interface:ChatChannelReturns a short description of this channel shown in menus.- Specified by:
descriptionin interfaceChatChannel
-
color
Description copied from interface:ChatChannelReturns the primary colour associated with this channel.- Specified by:
colorin interfaceChatChannel
-
formatBuilder
-
permission
Description copied from interface:ChatChannelReturns the permission node required to see or write in this channel, if any.- Specified by:
permissionin interfaceChatChannel
-
textColor
Description copied from interface:ChatChannelReturns an optional override colour applied to message text in this channel.- Specified by:
textColorin interfaceChatChannel
-
joinByDefault
public boolean joinByDefault()Description copied from interface:ChatChannelReturnstrueif players are automatically added to this channel on join.- Specified by:
joinByDefaultin interfaceChatChannel
-
prefix
@NotNull public @NotNull Component prefix(@NotNull @NotNull SocialUser user, @NotNull @NotNull SocialRegisteredMessageContext message, @NotNull @NotNull SocialParserContext parser) Description copied from interface:ChatChannelBuilds the rendered prefix shown before each message in this channel.- Specified by:
prefixin interfaceChatChannel- Parameters:
user- the message sendermessage- the registered message contextparser- the parser context used for placeholder resolution- Returns:
- the rendered prefix component
-
addMember
Description copied from interface:ChatChannelAdds the player with the given UUID to this channel.- Specified by:
addMemberin interfaceChatChannel- Parameters:
uuid- the player's UUID- Returns:
trueif the player was not already a member
-
removeMember
Description copied from interface:ChatChannelRemoves the player with the given UUID from this channel.- Specified by:
removeMemberin interfaceChatChannel- Parameters:
uuid- the player's UUID- Returns:
trueif the player was a member
-
members
Description copied from interface:ChatChannelReturns all users currently in this channel.- Specified by:
membersin interfaceChatChannel- Returns:
- the current members
-
isMember
Description copied from interface:ChatChannelReturnstrueif the player with the given UUID is a member of this channel.- Specified by:
isMemberin interfaceChatChannel- Parameters:
uuid- the player UUID to check- Returns:
trueif the player is a member
-