Package com.github.jamesnetherton.zulip.client.api.server.request

Class GetProfileFieldsApiRequest

java.lang.Object

com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

com.github.jamesnetherton.zulip.client.api.server.request.GetProfileFieldsApiRequest

All Implemented Interfaces:

ExecutableApiRequest<List<ProfileField>>

public class GetProfileFieldsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<ProfileField>>

Zulip API request builder for getting all custom profile fields.

See Also:

• https://zulip.com/api/get-custom-profile-fields

Constructor Summary

Constructors

Constructor	Description
GetProfileFieldsApiRequest(ZulipHttpClient client)	Constructs a GetProfileFieldsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<ProfileField>	execute()	Executes the Zulip API request for getting all custom profile fields.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

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

Constructor Details

GetProfileFieldsApiRequest

public GetProfileFieldsApiRequest(ZulipHttpClient client)

Constructs a GetProfileFieldsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<ProfileField> execute()
                           throws ZulipClientException

Executes the Zulip API request for getting all custom profile fields.

Specified by:

execute in interface ExecutableApiRequest<List<ProfileField>>

Returns:

List of ProfileField objects

Throws:

ZulipClientException - if the request was not successful