Class ProfileApi

java.lang.Object

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

All Implemented Interfaces:

EndpointCategory

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	ProfileApi.GetProfile	Handler for the getProfile API method that lets you choose the content type via the Accept header.

Constructor Summary

Constructors

Constructor	Description
ProfileApi(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()
ProfileApi.GetProfile	getProfile()	Retrieves the profile of the requesting user Retrieves a profile based on the requesting user.

Methods inherited from class Object

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

Constructor Details

ProfileApi

public ProfileApi(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.

getProfile

public ProfileApi.GetProfile getProfile()
                                 throws IllegalArgumentException

Retrieves the profile of the requesting user Retrieves a profile based on the requesting user.

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.