Package com.atlassian.jira.util
Interface JiraContactHelper
- All Known Implementing Classes:
JiraContactHelperImpl
public interface JiraContactHelper
Helper for getting User Contact information links
- Since:
- v4.4
-
Method Summary
Modifier and TypeMethodDescriptiongetAdministratorContactLink
(String baseUrl) Get link for the contact administrator page.getAdministratorContactLinkHtml
(String baseUrl, I18nHelper i18nHelper) Get the full link text for the contact administration message as a snippet.getAdministratorContactMessage
(I18nHelper i18nHelper) Get the text for the contact administration message as a snippet.boolean
Get the information whether Contact Administrator form can be used by users
-
Method Details
-
getAdministratorContactLinkHtml
Get the full link text for the contact administration message as a snippet. This message is not puncuated or capatilised and should be able to be inserted within a more complete message.
In English "Contact your Jira Administrators"
In some cases (e.g. empty base URL, or contact form turned off) this will just return a non-hyperlinked text message equivalent to
getAdministratorContactMessage(I18nHelper)
.- Parameters:
baseUrl
- Base Url of the application. Ifnull
, non-hyperlinked text will be returnedi18nHelper
- i18NHelper- Returns:
- String containing HTML
-
getAdministratorContactMessage
Get the text for the contact administration message as a snippet. This message is not puncuated or capatilised and should be able to be inserted within a more complete message. If you want a hyperlink then usegetAdministratorContactLinkHtml(String baseUrl, I18nHelper i18nHelper)
in English "contact your Jira Administrators"
- Parameters:
i18nHelper
- i18NHelper- Returns:
- String containing HTML
-
isAdministratorContactFormEnabled
boolean isAdministratorContactFormEnabled()Get the information whether Contact Administrator form can be used by users- Since:
- 6.1
-
getAdministratorContactLink
Get link for the contact administrator page. This method will not respect Contact Form's settings - it will always return a link
For example:
/jira/secure/ContactAdministrators!default.jspa
- Parameters:
baseUrl
- Base Url of the application- Returns:
- Since:
- 6.1
-