public interface ActionLogger
| Modifier and Type | Method and Description |
|---|---|
@NonNull CompletableFuture<Void> |
broadcastAction(@NonNull LogEntry entry)
Submits a log entry to the plugins log broadcasting handler.
|
@NonNull CompletableFuture<Log> |
getLog()
Gets a
Log instance from the plugin storage. |
LogEntry.Builder |
newEntryBuilder()
Returns a new
LogEntry.Builder instance |
@NonNull CompletableFuture<Void> |
submit(@NonNull LogEntry entry)
Submits a log entry to the plugin to be handled.
|
@NonNull CompletableFuture<Void> |
submitToStorage(@NonNull LogEntry entry)
Submits a log entry to the plugins storage handler.
|
LogEntry.Builder newEntryBuilder()
LogEntry.Builder instance@NonNull CompletableFuture<Log> getLog()
Log instance from the plugin storage.Storage.getLog()@NonNull CompletableFuture<Void> submit(@NonNull LogEntry entry)
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.
entry - the entry to submit@NonNull CompletableFuture<Void> submitToStorage(@NonNull LogEntry entry)
Performs the same action as Storage.logAction(LogEntry).
entry - the entry to submit@NonNull CompletableFuture<Void> broadcastAction(@NonNull LogEntry entry)
If enabled, this method will also dispatch the log entry via the
plugins MessagingService.
entry - the entry to submit