Package io.jenkins.plugins.interactiveinput.ui

Class InteractiveViewRunAction

java.lang.Object
io.jenkins.plugins.interactiveinput.ui.InteractiveViewRunAction
All Implemented Interfaces:
Action, BuildBadgeAction, ModelObject, Badgeable
public class InteractiveViewRunAction extends Object implements BuildBadgeAction, Badgeable
Per-build "Interactive View" surface. Attached to a Run by InteractiveViewRunAction.Factory only when that build has review documents in the ViewStore.

Renders a left-sidebar link (present on the run page and its sub-pages, including the Console Output) whose index.jelly is the Confluence-style review editor. As a BuildBadgeAction its badge.jelly marks builds that still have an open review in the build-history list. The editor page opens a specific review via ?doc=<id> (the console link and notification bell deep-link there); with no doc param it lists the build's reviews.

All permission and existence checks live in the ViewStore/REST layer; this action only exposes metadata for its Jelly views.

  • Field Details

    • URL_NAME

      public static final String URL_NAME
      Stable URL segment under the run (e.g. /job/foo/3/interactive-view/).
      See Also:

    • ICON

      public static final String ICON
      Theme-aware symbol for the review surfaces (distinct from the question bell icon).
      See Also:

  • Constructor Details

    • InteractiveViewRunAction

      public InteractiveViewRunAction(@NonNull Run<?,?> run)

  • Method Details

    • getRun

      @NonNull public Run<?,?> getRun()

    • getObject

      @NonNull public Run<?,?> getObject()
      Returns:
      the owning run. Required by core's l:run-subpage (it.object).

    • getJobFullName

      @NonNull public String getJobFullName()

    • getBuildNumber

      public int getBuildNumber()

    • getReviews

      @NonNull public List<ReviewDocument> getReviews()
      Returns:
      the reviews for this build the current viewer may read (any status).

    • isWaiting

      public boolean isWaiting()
      Returns:
      true if this build still has an open, notify-enabled review the current viewer should act on (drives the build-history badge), honouring the user-scope switch so it matches the bell and sidebar count.

    • getPendingCount

      public int getPendingCount()
      Returns:
      the OPEN, notify-enabled reviews on this build the current viewer should act on (0 on any store error), honouring the user-scope switch. Surfaces as getBadge() on the classic sidebar and experimental tab bar.

    • getPollingIntervalSeconds

      public int getPollingIntervalSeconds()

    • getIconFileName

      @CheckForNull public String getIconFileName()
      Specified by:
      getIconFileName in interface Action

    • getDisplayName

      @NonNull public String getDisplayName()
      Specified by:
      getDisplayName in interface Action
      Specified by:
      getDisplayName in interface ModelObject
      Returns:
      the stable sidebar / overflow label. The pending count is getBadge(), not a (N) suffix.

    • getBadge

      @CheckForNull public Badge getBadge()
      Specified by:
      getBadge in interface Badgeable
      Returns:
      a numeric DANGER badge while this build has open reviews the current viewer should act on; null at zero.

    • getUrlName

      @NonNull public String getUrlName()
      Specified by:
      getUrlName in interface Action