Package com.atlassian.jira.rest.v2.issue

Class UniversalAvatarResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.UniversalAvatarResource

@Path("universal_avatar")
@Consumes("application/json")
@Produces("application/json")
public class UniversalAvatarResource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOM_AVATARS_FIELD
static final String	SYSTEM_AVATARS_FIELD

Constructor Summary

Constructors

Constructor	Description
UniversalAvatarResource(JiraAuthenticationContext authContext, AvatarUrls avatarUrls, AvatarResourceHelper avatarResourceHelper, TemporaryAvatarHelper avatarTemporaryHelper, AvatarManager avatarManager, AvatarImageResolver avatarImageResolver)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createAvatarFromTemporary(String avatarType, String owningObjectId, AvatarCroppingBean croppingInstructions)
javax.ws.rs.core.Response	deleteAvatar(String avatarType, String owningObjectId, Long id)	Deletes avatar
javax.ws.rs.core.Response	getAvatars(String avatarType, String owningObjectId)
javax.ws.rs.core.Response	storeTemporaryAvatar(String avatarType, String owningObjectId, String filename, Long size, javax.servlet.http.HttpServletRequest request)	Creates temporary avatar
javax.ws.rs.core.Response	storeTemporaryAvatarUsingMultiPart(String avatarType, String owningObjectId, com.atlassian.plugins.rest.api.multipart.FilePart filePart, javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SYSTEM_AVATARS_FIELD

public static final String SYSTEM_AVATARS_FIELD

See Also:

• Constant Field Values

CUSTOM_AVATARS_FIELD

public static final String CUSTOM_AVATARS_FIELD

See Also:

• Constant Field Values

Constructor Details

UniversalAvatarResource

@Inject
public UniversalAvatarResource(JiraAuthenticationContext authContext,
 AvatarUrls avatarUrls,
 AvatarResourceHelper avatarResourceHelper,
 TemporaryAvatarHelper avatarTemporaryHelper,
 AvatarManager avatarManager,
 AvatarImageResolver avatarImageResolver)

Method Details

getAvatars

@GET
@Path("type/{type}/owner/{owningObjectId}")
public javax.ws.rs.core.Response getAvatars(@PathParam("type")
 String avatarType,
 @PathParam("owningObjectId")
 String owningObjectId)

Since:

v6.3

storeTemporaryAvatar

@POST
@Consumes("*/*")
@Path("type/{type}/owner/{owningObjectId}/temp")
public javax.ws.rs.core.Response storeTemporaryAvatar(@PathParam("type")
 String avatarType,
 @PathParam("owningObjectId")
 String owningObjectId,
 @QueryParam("filename")
 String filename,
 @QueryParam("size")
 Long size,
 @Context
 javax.servlet.http.HttpServletRequest request)

Creates temporary avatar

Parameters:

avatarType - Type of entity where to change avatar

owningObjectId - Entity id where to change avatar

filename - name of file being uploaded

size - size of file

request - servlet request

Returns:

temporary avatar cropping instructions

Since:

v5.0

storeTemporaryAvatarUsingMultiPart

@POST
@Consumes("multipart/form-data")
@Path("type/{type}/owner/{owningObjectId}/temp")
@Produces("text/html")
public javax.ws.rs.core.Response storeTemporaryAvatarUsingMultiPart(@PathParam("type")
 String avatarType,
 @PathParam("owningObjectId")
 String owningObjectId,
 com.atlassian.plugins.rest.api.multipart.FilePart filePart,
 @Context
 javax.servlet.http.HttpServletRequest request)

createAvatarFromTemporary

@POST
@Path("type/{type}/owner/{owningObjectId}/avatar")
public javax.ws.rs.core.Response createAvatarFromTemporary(@PathParam("type")
 String avatarType,
 @PathParam("owningObjectId")
 String owningObjectId,
 AvatarCroppingBean croppingInstructions)

deleteAvatar

@DELETE
@Path("type/{type}/owner/{owningObjectId}/avatar/{id}")
public javax.ws.rs.core.Response deleteAvatar(@PathParam("type")
 String avatarType,
 @PathParam("owningObjectId")
 String owningObjectId,
 @PathParam("id")
 Long id)

Deletes avatar

Parameters:

avatarType - Project id or project key

id - database id for avatar

Returns:

temporary avatar cropping instructions

Since:

v5.0