Class UserProfileImageApi

java.lang.Object

de.xima.fc.api.rest.pub.client.user.api.UserProfileImageApi

All Implemented Interfaces:

EndpointCategory

@Generated("de.xima.openapi.codegen.java_jaxrs.XimaJavaJaxrsGenerator")
public final class UserProfileImageApi
extends Object
implements EndpointCategory

The API for making structured REST API calls to the "UserProfileImageApi" endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	UserProfileImageApi.DownloadProfileImage	Handler for the downloadProfileImage API method that lets you choose the content type via the Accept header.

Constructor Summary

Constructors

Constructor	Description
UserProfileImageApi(ApiClient apiClient)	Creates a new API handler that uses the given client to send the HTTP requests.

Method Summary

Modifier and Type	Method	Description
String	category()
UserProfileImageApi.DownloadProfileImage	downloadProfileImage()	Download the profile image of the requesting user Download the profile image of the requesting user.

Methods inherited from class Object

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

Constructor Details

UserProfileImageApi

public UserProfileImageApi(ApiClient apiClient)

Creates a new API handler that uses the given client to send the HTTP requests.

Parameters:

apiClient - The client to use for HTTP requests.

Method Details

category

public String category()

Specified by:

category in interface EndpointCategory

Returns:

The name of this category.

downloadProfileImage

public UserProfileImageApi.DownloadProfileImage downloadProfileImage()
                                                              throws IllegalArgumentException

Download the profile image of the requesting user Download the profile image of the requesting user. The requesting user needs to be able to access the profile.

Returns:

A handler for making a call to the API with a given content type (accept header).

Throws:

IllegalArgumentException - When a required parameter is missing or a parameter does not confirm to the expected format.