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

Class UpdateUserApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateUserApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder to update a user.

See Also:

• https://zulip.com/api/update-user

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FULL_NAME
static final String	PROFILE_DATA
static final String	ROLE

Constructor Summary

Constructors

Constructor	Description
UpdateUserApiRequest(ZulipHttpClient client, long userId)	Constructs a UpdateUserApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating a user.
UpdateUserApiRequest	withFullName(String fullName)	Sets the updated name of the user.
UpdateUserApiRequest	withProfileData(int id, String value)	Sets updated custom profile data for the user.
UpdateUserApiRequest	withRole(UserRole role)	Sets the updated role of the user.

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

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

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

Field Details

FULL_NAME

public static final String FULL_NAME

See Also:

• Constant Field Values

PROFILE_DATA

public static final String PROFILE_DATA

See Also:

• Constant Field Values

ROLE

public static final String ROLE

See Also:

• Constant Field Values

Constructor Details

UpdateUserApiRequest

public UpdateUserApiRequest(ZulipHttpClient client,
 long userId)

Constructs a UpdateUserApiRequest.

Parameters:

client - The Zulip HTTP client

userId - The id of the user to update

Method Details

withFullName

public UpdateUserApiRequest withFullName(String fullName)

Sets the updated name of the user.

Parameters:

fullName - The updated user name

Returns:

This UpdateUserApiRequest instance

withRole

public UpdateUserApiRequest withRole(UserRole role)

Sets the updated role of the user.

Parameters:

role - The updated UserRole

Returns:

This UpdateUserApiRequest instance

withProfileData

public UpdateUserApiRequest withProfileData(int id,
 String value)

Sets updated custom profile data for the user.

Parameters:

id - The id of the custom profile field

value - The updated value for the custom profile field

Returns:

This UpdateUserApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating a user.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful