com.atlassian.confluence.user.service
Interface UserProfileService

All Known Implementing Classes:

DefaultUserProfileService

public interface UserProfileService

Service for user profile-related functions such as editing profiles, managing preferences and so on.

Method Summary

DeleteProfilePictureCommand	newDeleteProfilePictureCommand(com.atlassian.user.User user, String imageFileName) Get a service command for deleting a user's profile picture.
SetProfilePictureCommand	newSetProfilePictureCommand(com.atlassian.user.User user, InputStream imageData, String imageFileName) Get a service command for setting a user's profile picture from an uploaded photo.
SetProfilePictureCommand	newSetProfilePictureCommand(com.atlassian.user.User user, InputStream imageData, String imageFileName, int topLeftX, int topLeftY, int width) Get a service command for setting a user's profile picture from an uploaded photo.
SetProfilePictureCommand	newSetProfilePictureCommand(com.atlassian.user.User user, String imageFileName) Get a service command for setting a user's profile picture from an already existing attachment filename, or from one of the built-in icons.

Method Detail

newSetProfilePictureCommand

SetProfilePictureCommand newSetProfilePictureCommand(com.atlassian.user.User user,
                                                     InputStream imageData,
                                                     String imageFileName)

Get a service command for setting a user's profile picture from an uploaded photo. The image will be cropped and resized to fit.

Parameters:

user - the user to set a profile picture for

imageData - the image to use as a profile picture

imageFileName - the name of the uploaded image

Returns:

the relevant command

newSetProfilePictureCommand

SetProfilePictureCommand newSetProfilePictureCommand(com.atlassian.user.User user,
                                                     String imageFileName)

Get a service command for setting a user's profile picture from an already existing attachment filename, or from one of the built-in icons.

Parameters:

user - the user to set a profile picture for

imageFileName - the filename of the image to use as a profile picture

Returns:

the relevant command

newSetProfilePictureCommand

SetProfilePictureCommand newSetProfilePictureCommand(com.atlassian.user.User user,
                                                     InputStream imageData,
                                                     String imageFileName,
                                                     int topLeftX,
                                                     int topLeftY,
                                                     int width)

Get a service command for setting a user's profile picture from an uploaded photo. The image will be cropped with the given parameters and then resized to fit the standard profile picture size.

Parameters:

user - the user to set a profile picture for

imageData - the image to use as a profile picture

imageFileName - the name of the uploaded image

topLeftX - the X offset of the top left of the cropping area

topLeftY - the Y offset of the top left of the cropping area

width - the width of the cropping area (will always be square)

Returns:

the relevant command

newDeleteProfilePictureCommand

DeleteProfilePictureCommand newDeleteProfilePictureCommand(com.atlassian.user.User user,
                                                           String imageFileName)

Get a service command for deleting a user's profile picture.

Parameters:

user - the user to delete a profile picture for

imageFileName - the filename of the image to delete

Returns:

the relevant command