Package ovh.mythmc.social.api

Interface Social

public interface Social

The central entry-point for the social plugin API.

Use get() to retrieve the running instance and registries() to access the shared registries for channels, announcements, emojis and reactions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Social.ReloadType	Describes which parts of the plugin are affected by a reload operation.

Method Summary

Modifier and Type	Method	Description
static @NotNull Social	get()	Returns the active Social instance.
default @NotNull AnnouncementManager	getAnnouncementManager()	Returns the singleton AnnouncementManager.
default @NotNull ChatManager	getChatManager()	Returns the singleton ChatManager.
@NotNull SocialConfigProvider	getConfig()	Returns the configuration provider that exposes all plugin settings.
@NotNull LoggerWrapper	getLogger()	Returns the logger used throughout the plugin.
@NotNull ReactionFactory	getReactionFactory()	Returns the factory responsible for creating and managing chat reactions.
default @NotNull GlobalTextProcessor	getTextProcessor()	Returns the singleton GlobalTextProcessor used to parse and send messages.
default @NotNull SocialUserManager	getUserManager()	Returns the singleton SocialUserManager.
@NotNull SocialUserService	getUserService()	Returns the service used to retrieve all currently tracked SocialUser instances.
static @NotNull SocialRegistries	registries()	Returns the shared SocialRegistries that hold all registered channels, announcements, emojis and reactions.
void	reload(Social.ReloadType type)	Triggers an internal reload of the specified type.
String	version()	Returns the current version string of the social plugin.

Method Details

get

@NotNull
static @NotNull Social get()

Returns the active Social instance.

Returns:

the social API instance

registries

@NotNull
static @NotNull SocialRegistries registries()

Returns the shared SocialRegistries that hold all registered channels, announcements, emojis and reactions.

Returns:

the global registries

reload

@Internal
void reload(Social.ReloadType type)

Triggers an internal reload of the specified type.

Parameters:

type - the parts of the plugin to reload

version

String version()

Returns the current version string of the social plugin.

Returns:

version string

getLogger

@NotNull
@NotNull LoggerWrapper getLogger()

Returns the logger used throughout the plugin.

Returns:

the logger wrapper

getConfig

@NotNull
@NotNull SocialConfigProvider getConfig()

Returns the configuration provider that exposes all plugin settings.

Returns:

the config provider

getUserService

@NotNull
@NotNull SocialUserService getUserService()

Returns the service used to retrieve all currently tracked SocialUser instances.

Returns:

the user service

getReactionFactory

@NotNull
@NotNull ReactionFactory getReactionFactory()

Returns the factory responsible for creating and managing chat reactions.

Returns:

the reaction factory

getAnnouncementManager

@NotNull
default @NotNull AnnouncementManager getAnnouncementManager()

Returns the singleton AnnouncementManager.

Returns:

the announcement manager

getUserManager

@NotNull
default @NotNull SocialUserManager getUserManager()

Returns the singleton SocialUserManager.

Returns:

the user manager

getChatManager

@NotNull
default @NotNull ChatManager getChatManager()

Returns the singleton ChatManager.

Returns:

the chat manager

getTextProcessor

@NotNull
default @NotNull GlobalTextProcessor getTextProcessor()

Returns the singleton GlobalTextProcessor used to parse and send messages.

Returns:

the global text processor