Summary: Methods | [Expand All]
public interface

EntityType

com.atlassian.applinks.api.EntityType
Known Indirect Subclasses

Class Overview

Represents the type of an EntityLink. See the com.atlassian.applinks.api.application package for a list of EntityTypes bundled with the Unified Application Links plugin. Additional types can be added via the extension APIs in the applinks-spi module.

Summary

Public Methods
abstract Class<? extends ApplicationType> getApplicationType()
abstract URI getDisplayUrl(ApplicationLink link, String entityKey)

Given an ApplicationLink and the key of an entity on that peer, this method returns that entity's "display URL".

abstract String getI18nKey()
abstract URI getIconUrl()
abstract String getPluralizedI18nKey()
abstract String getShortenedI18nKey()

Public Methods

public abstract Class<? extends ApplicationType> getApplicationType ()

Returns

public abstract URI getDisplayUrl (ApplicationLink link, String entityKey)

Given an ApplicationLink and the key of an entity on that peer, this method returns that entity's "display URL". This would typically be the address where a user's browser is sent to when it follows the entity link.

Note that the caller does not guarantee that the specified entity key actually exists.

The implementation of this method is stringly recommended not to contact the peer either for validation of the supplied entity key, or help creating the display URL, as this method can be called multiple times during a page render.

Parameters
link the link MUST be of the same type as getApplicationType() or the result is unspecified.
entityKey the key of an enitity on the remote system.
Returns
  • the (remote) url for the specified entity key, or null when such URL is not available.

public abstract String getI18nKey ()

Returns
  • the key of an internationalized display name of this type e.g. "JIRA Project". You can resolve this key using the I18nResolver component provided by the SAL plugin.
See Also

public abstract URI getIconUrl ()

Returns
  • the icon url for this type, or null if an icon is not available.

public abstract String getPluralizedI18nKey ()

Returns
  • the pluralized version of getI18nKey() for this type name e.g. "JIRA Projects".
See Also

public abstract String getShortenedI18nKey ()

Returns
  • the shortened version of getI18nKey() for this type name e.g. "Project".
See Also