me.lucko.luckperms.api

Interface ActionLogger

public interface ActionLogger

Represents the object responsible for handling action logging.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	broadcastAction(LogEntry entry) Submits a log entry to the plugins log broadcasting handler.
CompletableFuture<Log>	getLog() Gets a Log instance from the plugin storage.
LogEntry.Builder	newEntryBuilder() Returns a new LogEntry.Builder instance
CompletableFuture<Void>	submit(LogEntry entry) Submits a log entry to the plugin to be handled.
CompletableFuture<Void>	submitToStorage(LogEntry entry) Submits a log entry to the plugins storage handler.

Method Detail

newEntryBuilder

@Nonnull
LogEntry.Builder newEntryBuilder()

Returns a new LogEntry.Builder instance

Returns:

a new builder

getLog

@Nonnull
CompletableFuture<Log> getLog()

Gets a Log instance from the plugin storage.

Returns:

a log instance

See Also:

Storage.getLog()

submit

@Nonnull
CompletableFuture<Void> submit(@Nonnull
                                         LogEntry entry)

Submits a log entry to the plugin to be handled.

This method submits the log to the storage provider and broadcasts it.

It is therefore roughly equivalent to calling submitToStorage(LogEntry) and broadcastAction(LogEntry), however, using this method is preferred to making the calls individually.

If you want to submit a log entry but don't know which method to pick, use this one.

Parameters:

entry - the entry to submit

Returns:

a future which will complete when the action is done

submitToStorage

@Nonnull
CompletableFuture<Void> submitToStorage(@Nonnull
                                                  LogEntry entry)

Submits a log entry to the plugins storage handler.

Performs the same action as Storage.logAction(LogEntry).

Parameters:

entry - the entry to submit

Returns:

a future which will complete when the action is done

broadcastAction

@Nonnull
CompletableFuture<Void> broadcastAction(@Nonnull
                                                  LogEntry entry)

Submits a log entry to the plugins log broadcasting handler.

If enabled, this method will also dispatch the log entry via the plugins MessagingService.

Parameters:

entry - the entry to submit

Returns:

a future which will complete when the action is done