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

Class UpdateOwnProfileDataApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateOwnProfileDataApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

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

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATA

Constructor Summary

Constructors

Constructor	Description
UpdateOwnProfileDataApiRequest(ZulipHttpClient client, List<Map<String,Object>> data)	Constructs an UpdateOwnProfileDataApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating 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

UpdateOwnProfileDataApiRequest

public UpdateOwnProfileDataApiRequest(ZulipHttpClient client,
 List<Map<String,Object>> data)

Constructs an UpdateOwnProfileDataApiRequest.

Parameters:

client - The Zulip HTTP client

data - List of maps each containing id (integer) and value (string or null) entries

Method Details

execute

public void execute()
             throws ZulipClientException

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

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful