com.atlassian.jira.avatar

Interface TemporaryAvatars

All Known Implementing Classes:

TemporaryAvatarsImpl

@PublicApi
public interface TemporaryAvatars

Emmanation of existing implicit link between REST plugin and core. Temporary avatar is created and stored in REST and displayed by servlet in core. This may be changed in future versions.

Since:

v6.3

Method Summary

Modifier and Type	Method and Description
void	dispose(TemporaryAvatar avatar) Dispose temporary avatar.
TemporaryAvatar	getCurrentTemporaryAvatar() Get current temporary avatar.
void	storeTemporaryAvatar(ApplicationUser remoteUser, TemporaryAvatar avatar, Avatar.Type type, String owningObjectId) Deprecated. This method cannot understand pluggable icon types. Use storeTemporaryAvatar(ApplicationUser, TemporaryAvatar, IconType, IconOwningObjectId). Since v7.1
void	storeTemporaryAvatar(ApplicationUser remoteUser, TemporaryAvatar avatar, IconType iconType, IconOwningObjectId owningObjectId) Store temporary avatar - make it available to displaying servlet.

Method Detail

storeTemporaryAvatar

void storeTemporaryAvatar(@Nonnull
                          ApplicationUser remoteUser,
                          @Nonnull
                          TemporaryAvatar avatar,
                          @Nonnull
                          Avatar.Type type,
                          @Nonnull
                          String owningObjectId)
                   throws IllegalAccessException

Deprecated. This method cannot understand pluggable icon types. Use storeTemporaryAvatar(ApplicationUser, TemporaryAvatar, IconType, IconOwningObjectId). Since v7.1

Store temporary avatar - make it available to displaying servlet. There is only one temporary avatar stored for user session.

Parameters:

remoteUser - user that access avatar - null can be used for anonymous access.

avatar - avatar to store

type - type for which this avatar is

owningObjectId - id of object (project/user/issuetype) to which this avatar is connected to

Throws:

IllegalAccessException

storeTemporaryAvatar

void storeTemporaryAvatar(@Nonnull
                          ApplicationUser remoteUser,
                          @Nonnull
                          TemporaryAvatar avatar,
                          @Nonnull
                          IconType iconType,
                          @Nonnull
                          IconOwningObjectId owningObjectId)
                   throws IllegalAccessException

Store temporary avatar - make it available to displaying servlet. There is only one temporary avatar stored for user session.

Parameters:

remoteUser - user that access avatar - null can be used for anonymous access.

avatar - avatar to store

iconType - type for which this avatar is

owningObjectId - id of object (project/user/issuetype) to which this avatar is connected to

Throws:

IllegalAccessException

Since:

v7.1

getCurrentTemporaryAvatar

@Nullable
TemporaryAvatar getCurrentTemporaryAvatar()

Get current temporary avatar.

dispose

void dispose(@Nonnull
             TemporaryAvatar avatar)

Dispose temporary avatar. Unsets if this is current temporary avatar.