com.atlassian.jira.plugin.myjirahome

Interface MyJiraHomeLinker

All Known Implementing Classes:

MyJiraHomeLinkerImpl

public interface MyJiraHomeLinker

Retrieves a link representing the current My JIRA Home. In case non is found, it falls back to DEFAULT_HOME_NOT_ANON or DEFAULT_HOME_OD_ANON.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOME_NOT_ANON
static String	DEFAULT_HOME_OD_ANON

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultUserHome() Returns the default My JIRA Home relative URL for logged in users.
String	getHomeLink(ApplicationUser user) Returns the My JIRA Home as a link for the given user.
String	getHomeLink(com.atlassian.crowd.embedded.api.User user) Deprecated. use getHomeLink(ApplicationUser) instead

Field Detail

DEFAULT_HOME_NOT_ANON

static final String DEFAULT_HOME_NOT_ANON

See Also:

Constant Field Values

DEFAULT_HOME_OD_ANON

static final String DEFAULT_HOME_OD_ANON

See Also:

Constant Field Values

Method Detail

getHomeLink

@Deprecated
@Nonnull
String getHomeLink(@Nullable
                                    com.atlassian.crowd.embedded.api.User user)

Deprecated. use getHomeLink(ApplicationUser) instead

Returns the My JIRA Home as a link for the given user.

Parameters:

user - the user for which the home link is requested

Returns:

the user's My JIRA Home, or one of DEFAULT_HOME_OD_ANON if anonymous or DEFAULT_HOME_NOT_ANON if logged in if none is defined or there were errors while loading.

getHomeLink

@Nonnull
String getHomeLink(@Nullable
                         ApplicationUser user)

Returns the My JIRA Home as a link for the given user.

Parameters:

user - the user for which the home link is requested

Returns:

the user's My JIRA Home, or one of DEFAULT_HOME_OD_ANON if anonymous or DEFAULT_HOME_NOT_ANON if logged in if none is defined or there were errors while loading.

Since:

6.4

getDefaultUserHome

@Nonnull
String getDefaultUserHome()

Returns the default My JIRA Home relative URL for logged in users.

Returns:

the default My JIRA Home relative URL for logged in users

Since:

6.4