Interface PunishmentView

public interface PunishmentView
Read-only view of a Plex punishment.

  • Method Details

    • punished

      UUID punished()
      Returns the UUID of the punished player.
      Returns:
      UUID of the punished player

    • punisher

      @Nullable @Nullable UUID punisher()
      Returns the UUID of the actor who issued the punishment.
      Returns:
      UUID of the actor who issued the punishment

    • source

      PunishmentSource source()
      Returns the source that issued the punishment.
      Returns:
      punishment source

    • punisherReference

      @Nullable @Nullable String punisherReference()
      Returns the source-specific punisher reference.
      Returns:
      punisher reference, or null when not applicable

    • punisherDisplayName

      String punisherDisplayName()
      Returns the resolved display name for the punishment actor.
      Returns:
      display name for the punishment actor

    • ip

      @Nullable @Nullable String ip()
      Returns the IP address associated with the punished player.
      Returns:
      IP address associated with the punished player

    • type

      PunishmentType type()
      Returns the punishment type.
      Returns:
      punishment type

    • reason

      String reason()
      Returns the punishment reason.
      Returns:
      punishment reason

    • active

      boolean active()
      Returns whether the punishment is currently active.
      Returns:
      whether the punishment is currently active

    • issueDate

      ZonedDateTime issueDate()
      Returns the date and time when the punishment was issued.
      Returns:
      date and time when the punishment was issued

    • endDate

      @Nullable @Nullable ZonedDateTime endDate()
      Returns the punishment end date.
      Returns:
      punishment end date, or null for punishments without an end date