com.atlassian.applinks.spi.application

Interface IconizedType

@PublicSpi
public interface IconizedType

Represents application or entity type that provides a high quality icon URI that will eventually supersedes ApplicationType#getIconUrl(). Application and entity types should optionally implement this SPI to indicate their ability to provide access to high quality icons representing those types.

Since:

4.3

See Also:

ApplicationType.getIconUrl()

Method Summary

Modifier and Type	Method and Description
URI	getIconUri() Provides URI to retrieve an icon for this application type

Method Detail

getIconUri

@Nullable
URI getIconUri()

Provides URI to retrieve an icon for this application type

Note that there are no guarantees for the resolution or size of the icon, other than it is a square (i.e. height is equal to width). It is responsibility of the clients that render icons provided via this URI to scale the icons to the desired size (e.g. using CSS for HTML clients). In other words clients should not rely on the size of the served icon as it may change in the future.

Returns:

URI of a high resolution icon for this application type or null if no icon is available

Since:

4.3