Class ProfileApi.GetProfile

java.lang.Object

de.xima.fc.api.rest.pub.client.user.ApiCall<ProfileApi.GetProfile>

de.xima.fc.api.rest.pub.client.user.EndpointCategoryCall<ProfileApi.GetProfile>

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

Enclosing class:

ProfileApi

public final class ProfileApi.GetProfile
extends EndpointCategoryCall<ProfileApi.GetProfile>

Handler for the getProfile API method that lets you choose the content type via the Accept header.

Field Summary

Fields inherited from class ApiCall

accept, apiCallInterceptor, authentications, authNames, body, cookieParams, headerParams, method, path, properties, queryParams, returnTypes

Method Summary

Modifier and Type	Method	Description
Class<? extends EndpointCategory>	endpointCategory()
ApiInvocation<DetailedUserProfileResource>	requestJson()	Calls the API with the Accept header set to application/json; charset=utf-8.
ApiInvocation<DetailedUserProfileResource>	requestJson_v1_0()	Calls the API with the Accept header set to application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8.
protected ProfileApi.GetProfile	self()

Methods inherited from class ApiCall

accept, accept, apiCallInterceptor, apiCallInterceptor, authentication, authentications, authentications, authNames, authNames, body, body, body, cookieParam, cookieParams, cookieParams, headerParam, headerParams, headerParams, method, method, path, path, properties, properties, property, queryParam, queryParams, queryParams, returnTypes, returnTypes

Methods inherited from class Object

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

Method Details

self

protected ProfileApi.GetProfile self()

Specified by:

self in class ApiCall<ProfileApi.GetProfile>

endpointCategory

public Class<? extends EndpointCategory> endpointCategory()

Specified by:

endpointCategory in class EndpointCategoryCall<ProfileApi.GetProfile>

Returns:

The endpoint category that created this API call.

requestJson

public ApiInvocation<DetailedUserProfileResource> requestJson()

Calls the API with the Accept header set to application/json; charset=utf-8.

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

Status codes that may be returned by this API call:

• 200 - The profile.

Returns:

A completion stage that resolves with the data returned by the API.

requestJson_v1_0

public ApiInvocation<DetailedUserProfileResource> requestJson_v1_0()

Calls the API with the Accept header set to application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8.

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

Status codes that may be returned by this API call:

• 200 - The profile.

Returns:

A completion stage that resolves with the data returned by the API.