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

Class DeleteProfileFieldApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class DeleteProfileFieldApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deleting a custom profile field.

Constructor Summary

Constructors

Constructor	Description
DeleteProfileFieldApiRequest(ZulipHttpClient client, long profileFieldId)	Constructs a DeleteProfileFieldApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for deleting a custom profile field.

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

DeleteProfileFieldApiRequest

public DeleteProfileFieldApiRequest(ZulipHttpClient client,
 long profileFieldId)

Constructs a DeleteProfileFieldApiRequest.

Parameters:

client - The Zulip HTTP client

profileFieldId - The id of the profile field to delete

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for deleting a custom profile field.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful