java.lang.Object | |
↳ | com.atlassian.jira.issue.link.RemoteIssueLink |
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).
@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).
Represents a link between a JIRA issue and a remote object in a remote application. Examples may include:
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
APPLICATION_TYPE_CONFLUENCE | |||||||||||
APPLICATION_TYPE_JIRA |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the human-readable name of the remote application instance that contains the remote object.
| |||||||||||
Returns the type of remote application that we are linking with.
| |||||||||||
Returns a String which uniquely identifies the object in the remote application.
| |||||||||||
Returns the tool tip text for the
icon . | |||||||||||
Returns a url for an icon to represent the remote object.
| |||||||||||
Returns the id of the link.
| |||||||||||
Returns the id of the issue we are linking with.
| |||||||||||
Returns a String which describes the relationship between the JIRA issue and the remote object.
| |||||||||||
Returns a hyperlink for the
status icon . | |||||||||||
Returns the tool tip text for the
status icon . | |||||||||||
Returns a url for an icon representing the status of the remote object.
| |||||||||||
Returns a summary of the remote object.
| |||||||||||
Returns a String to identify the remote object.
| |||||||||||
Returns a url to the object in the remote application.
| |||||||||||
Returns a Boolean to indicate whether the remote object is resolved or not.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Returns the human-readable name of the remote application instance that contains the remote object. Links are
grouped based on the applicationType
and applicationName in the user interface.
The applicationName is prepended to the iconTitle
to form the icon tool tip text.
For example: "My Company's Confluence", "HR JIRA", "Helpdesk JIRA"
Returns the type of remote application that we are linking with. This should be the product name, namespaced
with the product company. This value is not displayed in the JIRA user interface. Links are grouped based on the
applicationType and applicationName
in the user interface.
Renderering plugins can register to render a certain type of application. It is not possible to use a plugin to render links without an applicationType.
For example: "com.atlassian.confluence", "com.mycompany.myproduct"
Returns a String which uniquely identifies the object in the remote application. This value must be unique across all remote objects in all remote applications. The maximum length of this field is 255 characters.
For simplicity, this could simply be the url
, although this is not wise if there is a chance
the url may change.
This value is not displayed in the JIRA user interface. We suggest including in this field any values that will be needed by a renderer plugin, for example the application url and remote object identifier to make REST calls.
For example: "url=http://www.myapplication.com&ticketid=12345"
Returns the tool tip text for the icon
. The applicationName
is prepended to this value to form the icon tool tip text.
For example: "Bug - A problem which impairs or prevents the functions of the product"
icon
Returns a url for an icon to represent the remote object. The size of the icon should be 16x16 pixels.
For example: http://mycompany.com/jira/images/icons/bug.png
Returns the id of the link. This is used to refer to a link when updating and deleting.
Returns the id of the issue we are linking with.
Returns a String which describes the relationship between the JIRA issue and the remote object.
For example: "relates to", "is mentioned in", "links to". It could even be a simple noun, such as "Test Case".
Returns a hyperlink for the status icon
. If null, no hyperlink is shown. This value
is not used if the statusIconUrl
is null.
status icon
Returns the tool tip text for the status icon
. If null, no tool tip text is shown.
This value is not used if the statusIconUrl
is null.
status icon
Returns a url for an icon representing the status of the remote object. The size of the icon should be 16x16
pixels. This icon is shown next to the summary
in the JIRA user interface, and is right
justified. This icon does not have to strictly represent a "status", and may instead represent some secondary
information about the link.
For example: the status of a JIRA issue, the author of a test case
Returns a summary of the remote object. This is shown after the title
in the JIRA user
interface.
For example: a JIRA issue summary, a helpdesk ticket title
Returns a String to identify the remote object. This is shown as the text for the url
in the
JIRA user interface.
For example: a JIRA issue key, a Confluence page title, a helpdesk ticket number
Returns a url to the object in the remote application.
For example: a confluence page url
Returns a Boolean to indicate whether the remote object is resolved or not. If the value is true, it is "resolved", and if the value is false, it is "unresolved". This value will only make sense where the remote object is something that is resolvable (eg. an issue, support ticket, etc). It will not make sense for things like wiki pages. In that case, the value should be null.
If the value is true, the remote issue link be shown in a strikethrough font in the user interface.