com.atlassian.jira.avatar.Avatar |
Known Indirect Subclasses
|
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 an icon for a project or some other entity in JIRA.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Avatar.Size | The standard sizes for avatars. | ||||||||||
Avatar.Type | An indicator of the owner type of the avatar. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
demotedSystemProjectAvatars | These are the filenames of avatars that used to be available as system avatars, but were to be removed from the list of avatar options available to new projects. | ||||||||||
demotedSystemUserAvatars |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
The type of Avatar.
| |||||||||||
The MIME type of the avatar image file.
| |||||||||||
The base filename to the avatar image file.
| |||||||||||
The database identifier for the Avatar, may be null if it hasn't yet been stored or if database identifiers are
not supported.
| |||||||||||
A String representation of the identity of the domain object that this avatar is an avatar for!
For example, if it is a user avatar, it would be the username (since that is the primary key), for a Project
it is the project ID as a String.
| |||||||||||
Indicates whether the Avatar is a system-provided one or if users have defined it.
|
These are the filenames of avatars that used to be available as system avatars, but were to be removed from the list of avatar options available to new projects.
The MIME type of the avatar image file.
The base filename to the avatar image file. The actual file name will be modified with the id etc.
The database identifier for the Avatar, may be null if it hasn't yet been stored or if database identifiers are not supported. This will always return null for user avatars in some deployment configurations. Avatars for other purposes (e.g. Projects) may follow this in future versions and this method will be deprecated entirely. The id should not be used to construct URLs to the currently-configured avatar for anything. This method should only be used when it is necessary to refer to an avatar that is not currently the configured avatar for the domain object. The only use cases where this is needed are those to do with modifying or viewing detailed avatar configuration.
A String representation of the identity of the domain object that this avatar is an avatar for!
For example, if it is a user avatar, it would be the username (since that is the primary key), for a Project
it is the project ID as a String. The meaning of this should be determined by the
Avatar.Type
.
Indicates whether the Avatar is a system-provided one or if users have defined it.