@PublicApi @Immutable public final class

GetActionsRequest

extends Object
java.lang.Object
   ↳ com.atlassian.jira.plugin.issuetabpanel.GetActionsRequest

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Request object used in the IssueTabPanel2 SPI.

See Also

Summary

Public Constructors
@Internal GetActionsRequest(Issue issue, ApplicationUser remoteUser, boolean asynchronous, boolean showAll, String focusId)
Public Methods
String getFocusId()
boolean isAnonymous()
boolean isAsynchronous()
boolean isShowAll()
@Nonnull Issue issue()
ApplicationUser loggedInUser()
@Nullable ApplicationUser remoteUser()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

@Internal public GetActionsRequest (Issue issue, ApplicationUser remoteUser, boolean asynchronous, boolean showAll, String focusId)

@Internal

This constructor is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Public Methods

public String getFocusId ()

Returns
  • id of the action that should be focused e.g. commentId for the comments tab

    Used by tabs that limit the number of actions to show, so that the focused action can always be displayed

public boolean isAnonymous ()

Returns
  • true iff the user that is viewing the page is anonymous (i.e. not logged in)

public boolean isAsynchronous ()

Returns
  • true if the actions are being loaded asynchronously, e.g. using an AJAX request

public boolean isShowAll ()

Returns
  • true if all the actions should be returned

    Used by tabs that limit the number of actions to show (e.g. comments tab)

@Nonnull public Issue issue ()

Returns
  • the Issue on which the panel will be displayed

public ApplicationUser loggedInUser ()

@Nullable public ApplicationUser remoteUser ()

Returns
  • the User that is viewing the page, or null for an anonymous user