me.lucko.luckperms.api.messenger

Interface IncomingMessageConsumer

public interface IncomingMessageConsumer

Encapsulates the LuckPerms system which accepts incoming Messages from implementations of MessengerProvider.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
boolean	consumeIncomingMessage(Message message) Consumes a message instance.
boolean	consumeIncomingMessageAsString(String encodedString) Consumes a message in an encoded string format.

Method Detail

consumeIncomingMessage

boolean consumeIncomingMessage(@Nonnull
                               Message message)

Consumes a message instance.

The boolean returned from this method indicates whether or not the platform accepted the message. Some implementations which have multiple distribution channels may wish to use this result to dispatch the same message back to additional receivers.

The implementation will usually return false if a message with the same ping id has already been processed.

Parameters:

message - the message

Returns:

true if the message was accepted by the plugin

consumeIncomingMessageAsString

boolean consumeIncomingMessageAsString(@Nonnull
                                       String encodedString)

Consumes a message in an encoded string format.

This method will decode strings obtained by calling OutgoingMessage.asEncodedString(). This means that basic implementations can successfully implement Messenger without providing their own serialisation.

The boolean returned from this method indicates whether or not the platform accepted the message. Some implementations which have multiple distribution channels may wish to use this result to dispatch the same message back to additional receivers.

The implementation will usually return false if a message with the same ping id has already been processed.

Parameters:

encodedString - the encoded string

Returns:

true if the message was accepted by the plugin