me.lucko.luckperms.api.messenger

Interface MessengerProvider

public interface MessengerProvider

Represents a provider for Messenger instances.

Users wishing to provide their own implementation for the plugins "Messaging Service" should implement and register this interface.

Since:

4.1

See Also:

LuckPermsApi.registerMessengerProvider(MessengerProvider)

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the name of this provider.
Messenger	obtain(IncomingMessageConsumer incomingMessageConsumer) Creates and returns a new Messenger instance, which passes incoming messages to the provided IncomingMessageConsumer.

Method Detail

getName

@Nonnull
String getName()

Gets the name of this provider.

Returns:

the provider name

obtain

@Nonnull
Messenger obtain(@Nonnull
                           IncomingMessageConsumer incomingMessageConsumer)

Creates and returns a new Messenger instance, which passes incoming messages to the provided IncomingMessageConsumer.

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