Package me.despical.commandframework.annotations

Annotation Interface Confirmation

@Documented @Target(METHOD) @Retention(RUNTIME) public @interface Confirmation
Author:
Despical

Created at 5.02.2024

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    int
    expireAfter
    How many seconds should pass so the confirmation gets expired.
    String
    message
    The message will be sent to the sender if they have not confirmed yet.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    bypassPerm
    The permission to bypass confirmations.
    boolean
    overrideConsole
    If option is true, console will be affected by confirmations; otherwise, it will override the confirmation period to use the command again.
    TimeUnit
    timeUnit
    The time unit for #expireAfter().

  • Element Details

    • message

      String message
      The message will be sent to the sender if they have not confirmed yet.
      Returns:
      the confirmation message.

    • bypassPerm

      String bypassPerm
      The permission to bypass confirmations.
      Returns:
      the bypass permission.
      Default:
      ""

    • expireAfter

      int expireAfter
      How many seconds should pass so the confirmation gets expired.
      Returns:
      the time required for the confirmation period to expire.
      See Also:

    • timeUnit

      TimeUnit timeUnit
      The time unit for #expireAfter().
      Returns:
      the unit of expiration time.
      Default:
      SECONDS

    • overrideConsole

      boolean overrideConsole
      If option is true, console will be affected by confirmations; otherwise, it will override the confirmation period to use the command again.
      Returns:
      false if console overrides confirmations, otherwise true
      Default:
      false