com.atlassian.jira.avatar
Interface AvatarService

All Known Implementing Classes:
AvatarServiceImpl

@PublicApi
public interface AvatarService

Service for manipulating Avatar's.

Since:
v4.3

Method Summary
 boolean canSetCustomUserAvatar(ApplicationUser remoteUser, ApplicationUser user)
          Returns a boolean indicating whether the calling user can edit the custom user avatar for the user with the given username.
 boolean canSetCustomUserAvatar(com.atlassian.crowd.embedded.api.User remoteUser, String username)
          Deprecated. Use canSetCustomUserAvatar(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser). Since v6.0
 Avatar getAvatar(ApplicationUser remoteUser, ApplicationUser avatarUser)
          Returns the Avatar for the given user, if configured.
 Avatar getAvatar(com.atlassian.crowd.embedded.api.User remoteUser, String username)
          Deprecated. Use getAvatar(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser). Since v6.0
 URI getAvatarAbsoluteURL(ApplicationUser remoteUser, ApplicationUser avatarUser, Avatar.Size size)
          This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but returns an absolute URL.
 URI getAvatarAbsoluteURL(com.atlassian.crowd.embedded.api.User remoteUser, String username, Avatar.Size size)
          Deprecated. Use getAvatarAbsoluteURL(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.avatar.Avatar.Size). Since v6.0
 Avatar getAvatarTagged(ApplicationUser remoteUser, ApplicationUser avatarUser)
           
 URI getAvatarURL(ApplicationUser remoteUser, ApplicationUser avatarUser)
          Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.
 URI getAvatarURL(ApplicationUser remoteUser, ApplicationUser avatarUser, Avatar.Size size)
          Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.
 URI getAvatarURL(com.atlassian.crowd.embedded.api.User remoteUser, String username)
          Deprecated. Use getAvatarURL(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser). Since v6.0
 URI getAvatarURL(com.atlassian.crowd.embedded.api.User remoteUser, String username, Avatar.Size size)
          Deprecated. Use getAvatarURL(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.avatar.Avatar.Size). Since v6.0
 URI getAvatarUrlNoPermCheck(ApplicationUser avatarUser, Avatar.Size size)
          This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but does no permission checking.
 URI getAvatarUrlNoPermCheck(ApplicationUser applicationUser, Avatar avatar, Avatar.Size size)
          Returns the URL for an avatar.
 URI getAvatarUrlNoPermCheck(String username, Avatar.Size size)
          Deprecated. Use getAvatarUrlNoPermCheck(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.avatar.Avatar.Size). Since v6.0
 URI getProjectAvatarAbsoluteURL(Project project, Avatar.Size size)
          Returns the URL for the avatar of the given project.
 URI getProjectAvatarURL(Project project, Avatar.Size size)
          Returns the URL for the avatar of the given project.
 URI getProjectDefaultAvatarAbsoluteURL(Avatar.Size size)
          Returns the URL for the default avatar of a project.
 URI getProjectDefaultAvatarURL(Avatar.Size size)
          Returns the URL for the default avatar of a project.
 boolean hasCustomUserAvatar(ApplicationUser remoteUser, ApplicationUser username)
          Returns true if the user has configured a custom avatar, false otherwise.
 boolean hasCustomUserAvatar(com.atlassian.crowd.embedded.api.User remoteUser, String username)
          Deprecated. Use hasCustomUserAvatar(ApplicationUser remoteUser, ApplicationUser username). Since v6.0
 boolean isGravatarEnabled()
          Returns true if Gravatar support is enabled.
 boolean isUsingExternalAvatar(ApplicationUser remoteUser, ApplicationUser avatarUser)
          Check whether a user currently has an external avatar (for example, a Gravatar).
 void setCustomUserAvatar(ApplicationUser remoteUser, ApplicationUser user, Long avatarId)
          Sets a custom avatar for a given user.
 void setCustomUserAvatar(com.atlassian.crowd.embedded.api.User remoteUser, String username, Long avatarId)
          Deprecated. Use setCustomUserAvatar(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser, Long). Since v6.0
 

Method Detail

getAvatar

Avatar getAvatar(com.atlassian.crowd.embedded.api.User remoteUser,
                 String username)
                 throws AvatarsDisabledException
Deprecated. Use getAvatar(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser). Since v6.0

Returns the Avatar for the given user, if configured. If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the default avatar. If the user does not exist, this method returns the anonymous avatar.

If this method would return the default user avatar but none is configured, or if this method would return the anonymous avatar but none is configured, this method returns null.

Parameters:
remoteUser - the User that wants to view an Avatar
username - a String containing a username (may have been deleted)
Returns:
an Avatar, or null
Throws:
AvatarsDisabledException - if avatars are disabled
Since:
v4.3

getAvatar

Avatar getAvatar(ApplicationUser remoteUser,
                 ApplicationUser avatarUser)
                 throws AvatarsDisabledException
Returns the Avatar for the given user, if configured. If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the default avatar. If the user does not exist, this method returns the anonymous avatar.

If this method would return the default user avatar but none is configured, or if this method would return the anonymous avatar but none is configured, this method returns null.

Parameters:
remoteUser - the User that wants to view an Avatar
avatarUser - the User that the avatar will be returned for (if null it will return a default avatar if it's set or null)
Returns:
an Avatar, or null
Throws:
AvatarsDisabledException - if avatars are disabled
Since:
v6.0

getAvatarURL

URI getAvatarURL(com.atlassian.crowd.embedded.api.User remoteUser,
                 String username)
                 throws AvatarsDisabledException
Deprecated. Use getAvatarURL(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser). Since v6.0

Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser. This method returns a URL for an avatar with the default size.

If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the URL of the default avatar. If the user does not exist, this method returns the URL of the anonymous avatar.

Parameters:
remoteUser - a User object for the currently logged in user
username - a String containing a username (may have been deleted)
Returns:
a URL that can be used to display the avatar
Throws:
AvatarsDisabledException - if avatars are disabled
Since:
v5.0.3
See Also:
getAvatar(com.atlassian.crowd.embedded.api.User, String)

getAvatarURL

URI getAvatarURL(ApplicationUser remoteUser,
                 ApplicationUser avatarUser)
                 throws AvatarsDisabledException
Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser. This method returns a URL for an avatar with the default size.

If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the URL of the default avatar. If the user does not exist, this method returns the URL of the anonymous avatar.

Parameters:
remoteUser - a User object for the currently logged in user
avatarUser - a User object to get the avatar for (if null, the default avatar is used)
Returns:
a URL that can be used to display the avatar
Throws:
AvatarsDisabledException - if avatars are disabled
Since:
v6.0
See Also:
getAvatar(com.atlassian.crowd.embedded.api.User, String)

getAvatarURL

URI getAvatarURL(com.atlassian.crowd.embedded.api.User remoteUser,
                 String username,
                 Avatar.Size size)
                 throws AvatarsDisabledException
Deprecated. Use getAvatarURL(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.avatar.Avatar.Size). Since v6.0

Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.

If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the URL of the default avatar. If the user does not exist, this method returns the URL of the anonymous avatar.

Parameters:
remoteUser - a User object for the currently logged in user
username - a String containing a username (may have been deleted)
size - the size of the avatar to be displayed (if null, the default size is used)
Returns:
a URL that can be used to display the avatar
Throws:
AvatarsDisabledException - if avatars are disabled
Since:
v4.3
See Also:
getAvatar(com.atlassian.crowd.embedded.api.User, String)

getAvatarURL

URI getAvatarURL(ApplicationUser remoteUser,
                 ApplicationUser avatarUser,
                 Avatar.Size size)
                 throws AvatarsDisabledException
Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.

If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the URL of the default avatar. If the user does not exist, this method returns the URL of the anonymous avatar.

Parameters:
remoteUser - a User object for the currently logged in user
avatarUser - a User to get the avatar for (if null, the default avatar is used)
size - the size of the avatar to be displayed (if null, the default size is used)
Returns:
a URL that can be used to display the avatar
Throws:
AvatarsDisabledException - if avatars are disabled
Since:
v6.0
See Also:
getAvatar(com.atlassian.crowd.embedded.api.User, String)

getAvatarUrlNoPermCheck

URI getAvatarUrlNoPermCheck(String username,
                            Avatar.Size size)
                            throws AvatarsDisabledException
Deprecated. Use getAvatarUrlNoPermCheck(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.avatar.Avatar.Size). Since v6.0

This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but does no permission checking.

Parameters:
username - a String containing a username (may have been deleted)
size - the size of the avatar to be displayed (if null, the default size is used)
Returns:
a URL that can be used to display the avatar
Throws:
AvatarsDisabledException - if avatars are disabled
Since:
v5.0

getAvatarUrlNoPermCheck

URI getAvatarUrlNoPermCheck(ApplicationUser avatarUser,
                            Avatar.Size size)
                            throws AvatarsDisabledException
This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but does no permission checking.

Parameters:
avatarUser - a String containing a username (if null, the default avatar is used)
size - the size of the avatar to be displayed (if null, the default size is used)
Returns:
a URL that can be used to display the avatar
Throws:
AvatarsDisabledException - if avatars are disabled
Since:
v6.0

getAvatarUrlNoPermCheck

URI getAvatarUrlNoPermCheck(ApplicationUser applicationUser,
                            Avatar avatar,
                            @Nonnull
                            Avatar.Size size)
                            throws AvatarsDisabledException
Returns the URL for an avatar.

Parameters:
applicationUser -
size - the size of the avatar to be displayed (if null, the default size is used)
Returns:
a URL that can be used to display the avatar
Throws:
AvatarsDisabledException - if avatars are disabled
Since:
v6.3
See Also:
getAvatar(com.atlassian.crowd.embedded.api.User, String)

getAvatarAbsoluteURL

URI getAvatarAbsoluteURL(com.atlassian.crowd.embedded.api.User remoteUser,
                         String username,
                         Avatar.Size size)
                         throws AvatarsDisabledException
Deprecated. Use getAvatarAbsoluteURL(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.avatar.Avatar.Size). Since v6.0

This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but returns an absolute URL.

Throws:
AvatarsDisabledException

getAvatarAbsoluteURL

URI getAvatarAbsoluteURL(ApplicationUser remoteUser,
                         ApplicationUser avatarUser,
                         Avatar.Size size)
                         throws AvatarsDisabledException
This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but returns an absolute URL.

Throws:
AvatarsDisabledException
Since:
v6.0

getProjectAvatarURL

URI getProjectAvatarURL(Project project,
                        Avatar.Size size)
Returns the URL for the avatar of the given project.

If running in the context of a web request, this will return a URL relative to the server root (ie "/jira/..."). Otherwise, it will return an absolute URL (eg. "http://example.com/jira/...").

Parameters:
project - the Project of which to get the avatar URL
size - the size of the avatar to be displayed (if null, the default size is used)
Returns:
a URL that can be used to display the avatar

getProjectAvatarAbsoluteURL

URI getProjectAvatarAbsoluteURL(Project project,
                                Avatar.Size size)
Returns the URL for the avatar of the given project.

This will always return an absolute URL (eg. "http://example.com/jira/...").

Parameters:
project - the Project of which to get the avatar URL
size - the size of the avatar to be displayed (if null, the default size is used)
Returns:
a URL that can be used to display the avatar

getProjectDefaultAvatarURL

URI getProjectDefaultAvatarURL(Avatar.Size size)
Returns the URL for the default avatar of a project.

If running in the context of a web request, this will return a URL relative to the server root (ie "/jira/..."). Otherwise, it will return an absolute URL (eg. "http://example.com/jira/...").

Parameters:
size - the size of the avatar to be displayed (if null, the default size is used)
Returns:
a URL that can be used to display the avatar

getProjectDefaultAvatarAbsoluteURL

URI getProjectDefaultAvatarAbsoluteURL(Avatar.Size size)
Returns the URL for the default avatar of a project.

This will always return an absolute URL (eg. "http://example.com/jira/...").

Parameters:
size - the size of the avatar to be displayed (if null, the default size is used)
Returns:
a URL that can be used to display the avatar

hasCustomUserAvatar

@ExperimentalApi
boolean hasCustomUserAvatar(com.atlassian.crowd.embedded.api.User remoteUser,
                                            String username)
Deprecated. Use hasCustomUserAvatar(ApplicationUser remoteUser, ApplicationUser username). Since v6.0

Returns true if the user has configured a custom avatar, false otherwise.

Parameters:
remoteUser - a User object for the currently logged in user
username - the username of the user whose avatar we will check
Returns:
a boolean indicating whether the given user has configued a custom avatar
Since:
v5.0.3

hasCustomUserAvatar

@ExperimentalApi
boolean hasCustomUserAvatar(ApplicationUser remoteUser,
                                            ApplicationUser username)
Returns true if the user has configured a custom avatar, false otherwise.

Parameters:
remoteUser - a User object for the currently logged in user
username - the username of the user whose avatar we will check
Returns:
a boolean indicating whether the given user has configued a custom avatar
Since:
v6.0

isGravatarEnabled

@ExperimentalApi
boolean isGravatarEnabled()
Returns true if Gravatar support is enabled.

Returns:
a boolean indicating whether Gravatar support is on

isUsingExternalAvatar

boolean isUsingExternalAvatar(ApplicationUser remoteUser,
                              ApplicationUser avatarUser)
Check whether a user currently has an external avatar (for example, a Gravatar). Use getAvatarURL(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser) to get the avatar URL.

Returns:
a boolean indicating whether the given currently user has an external avatar
Since:
JIRA 6.3

setCustomUserAvatar

@ExperimentalApi
void setCustomUserAvatar(com.atlassian.crowd.embedded.api.User remoteUser,
                                         String username,
                                         Long avatarId)
                         throws AvatarsDisabledException,
                                NoPermissionException
Deprecated. Use setCustomUserAvatar(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser, Long). Since v6.0

Sets a custom avatar for a given user.

Parameters:
remoteUser - a User object for the currently logged in user
username - the username of the user whose avatar we will configure
avatarId - the id of the avatar to configure for the user
Throws:
AvatarsDisabledException - if avatars are disabled
NoPermissionException - if the remote user does not have permission to update the given user's avatar
Since:
v5.0.3
See Also:
canSetCustomUserAvatar(com.atlassian.crowd.embedded.api.User, String)

setCustomUserAvatar

@ExperimentalApi
void setCustomUserAvatar(ApplicationUser remoteUser,
                                         ApplicationUser user,
                                         Long avatarId)
                         throws AvatarsDisabledException,
                                NoPermissionException
Sets a custom avatar for a given user.

Parameters:
remoteUser - a User object for the currently logged in user
user - the user whose avatar we will configure
avatarId - the id of the avatar to configure for the user
Throws:
AvatarsDisabledException - if avatars are disabled
NoPermissionException - if the remote user does not have permission to update the given user's avatar
Since:
v6.0
See Also:
canSetCustomUserAvatar(com.atlassian.crowd.embedded.api.User, String)

canSetCustomUserAvatar

@ExperimentalApi
boolean canSetCustomUserAvatar(com.atlassian.crowd.embedded.api.User remoteUser,
                                               String username)
Deprecated. Use canSetCustomUserAvatar(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser). Since v6.0

Returns a boolean indicating whether the calling user can edit the custom user avatar for the user with the given username.

Parameters:
remoteUser - a User object for the currently logged in user
username - the username of the user whose avatar we will configure
Returns:
a indicating whether the calling user can edit the custom user avatar for another user
Since:
v5.0.3

canSetCustomUserAvatar

@ExperimentalApi
boolean canSetCustomUserAvatar(ApplicationUser remoteUser,
                                               ApplicationUser user)
Returns a boolean indicating whether the calling user can edit the custom user avatar for the user with the given username.

Parameters:
remoteUser - a User object for the currently logged in user
user - the user whose avatar we will configure
Returns:
a indicating whether the calling user can edit the custom user avatar for another user
Since:
v6.0

getAvatarTagged

Avatar getAvatarTagged(ApplicationUser remoteUser,
                       ApplicationUser avatarUser)
                       throws AvatarsDisabledException
Throws:
AvatarsDisabledException


Copyright © 2002-2015 Atlassian. All Rights Reserved.