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

Class DeleteOwnProfileDataApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.DeleteOwnProfileDataApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class DeleteOwnProfileDataApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for removing the current user's custom profile field data.

See Also:

• https://zulip.com/api/remove-profile-data

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATA

Constructor Summary

Constructors

Constructor	Description
DeleteOwnProfileDataApiRequest(ZulipHttpClient client, List<Integer> fieldIds)	Constructs a DeleteOwnProfileDataApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for removing the current user's profile data.

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

Field Details

DATA

public static final String DATA

See Also:

• Constant Field Values

Constructor Details

DeleteOwnProfileDataApiRequest

public DeleteOwnProfileDataApiRequest(ZulipHttpClient client,
 List<Integer> fieldIds)

Constructs a DeleteOwnProfileDataApiRequest.

Parameters:

client - The Zulip HTTP client

fieldIds - List of custom profile field IDs to remove data for

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for removing the current user's profile data.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful