Package net.luckperms.api.messenger
Interface MessengerProvider
-
@OverrideOnly public interface MessengerProvider
Represents a provider forMessengerinstances.Users wishing to provide their own implementation for the plugins "Messaging Service" should implement and register this interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NonNull StringgetName()Gets the name of this provider.@NonNull Messengerobtain(@NonNull IncomingMessageConsumer incomingMessageConsumer)Creates and returns a newMessengerinstance, which passes incoming messages to the providedIncomingMessageConsumer.
-
-
-
Method Detail
-
obtain
@NonNull Messenger obtain(@NonNull IncomingMessageConsumer incomingMessageConsumer)
Creates and returns a newMessengerinstance, which passes incoming messages to the providedIncomingMessageConsumer.As the agent should pass incoming messages to the given consumer, this method should always return a new object.
- Parameters:
incomingMessageConsumer- the consumer the new instance should pass incoming messages to- Returns:
- a new messenger agent instance
-
-