Package net.luckperms.api.actionlog

Interface ActionLogger

public interface ActionLogger
Represents the object responsible for handling action logging.

  • Method Details

    • actionBuilder

      @NonNull Action.Builder actionBuilder()
      Returns a new Action.Builder instance
      Returns:
      a new builder

    • getLog

      @NonNull CompletableFuture<ActionLog> getLog()
      Gets a ActionLog instance from the plugin storage.
      Returns:
      a log instance

    • submit

      @NonNull CompletableFuture<Void> submit(@NonNull Action 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(Action) and broadcastAction(Action), 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 Action entry)
      Submits a log entry to the plugins storage handler.
      Parameters:
      entry - the entry to submit
      Returns:
      a future which will complete when the action is done

    • broadcastAction

      @NonNull CompletableFuture<Void> broadcastAction(@NonNull Action 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