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

Class ReorderProfileFieldsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class ReorderProfileFieldsApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for reordering custom profile fields.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER

Constructor Summary

Constructors

Constructor	Description
ReorderProfileFieldsApiRequest(ZulipHttpClient client, int... order)	Constructs a ReorderProfileFieldsApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for reordering custom profile fields.

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

client, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

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

Field Details

ORDER

public static final String ORDER

See Also:

• Constant Field Values

Constructor Details

ReorderProfileFieldsApiRequest

public ReorderProfileFieldsApiRequest(ZulipHttpClient client,
 int... order)

Constructs a ReorderProfileFieldsApiRequest.

Parameters:

client - The Zulip HTTP client

order - The array of custom profile field ids in the order that they should appear on the Zulip UI

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for reordering custom profile fields.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful