GetAvatarChangeUrl (Gerrit Review Plugin API Documentation)

java.lang.Object

com.google.gerrit.server.restapi.account.GetAvatarChangeUrl

All Implemented Interfaces:: RestReadView<AccountResource>, RestView<AccountResource>

public class GetAvatarChangeUrl extends Object implements RestReadView<AccountResource>

REST endpoint to get the URL for changing the avatar image of an account.

This REST endpoint handles GET /accounts/<account-identifier>/avatar.change.url requests.

Avatar images are only available if an AvatarProvider plugin is installed. Not all avatar plugins provide a URL for changing avatar images.

Method Summary

Modifier and Type

Method

Description

Response<String>

apply(AccountResource rsrc)

Process the view operation by reading from the resource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- apply
  
  public Response<String> apply(AccountResource rsrc) throws ResourceNotFoundException
  
  Description copied from interface: RestReadView
  
  Process the view operation by reading from the resource.
  The value of the returned response is automatically converted to JSON unless it is a BinaryResult.
  The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).
  Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.
  
  Specified by:
  
  apply in interface RestReadView<AccountResource>
  
  Parameters:
  
  rsrc - resource to read
  
  Returns:
  
  response to return to the client
  
  Throws:
  
  ResourceNotFoundException