com.google.gerrit.server.avatar

Interface AvatarProvider

public interface AvatarProvider

Provide avatar URLs for specified user.

Invoked by Gerrit when Avatar image requests are made.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChangeAvatarUrl(IdentifiedUser forUser) Gets a URL for a user to modify their avatar image.
java.lang.String	getUrl(IdentifiedUser forUser, int imageSize) Get avatar URL.

Method Detail

getUrl

java.lang.String getUrl(IdentifiedUser forUser,
                        int imageSize)

Get avatar URL.

Parameters:

forUser - The user for which to load an avatar image

imageSize - A requested image size, in pixels. An imageSize of 0 indicates to use whatever default size the provider determines. AvatarProviders may ignore the requested image size. The web interface will resize any image to match imageSize, so ideally the provider should return an image sized correctly.

Returns:

a URL of an avatar image for the specified user. A return value of null is acceptable, and results in the server responding with a 404. This will hide the avatar image in the web UI.

getChangeAvatarUrl

java.lang.String getChangeAvatarUrl(IdentifiedUser forUser)

Gets a URL for a user to modify their avatar image.

Parameters:

forUser - The user wishing to change their avatar image

Returns:

a URL the user should visit to modify their avatar, or null if modification is not possible.