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

Class UpdateUserByEmailApiRequest

java.lang.Object

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

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateUserByEmailApiRequest
extends UpdateUserApiRequest
implements VoidExecutableApiRequest

Zulip API request builder to update a user by their email address.

See Also:

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

Field Summary

Fields inherited from class com.github.jamesnetherton.zulip.client.api.user.request.UpdateUserApiRequest

FULL_NAME, NEW_EMAIL, PROFILE_DATA, ROLE

Constructor Summary

Constructors

Constructor	Description
UpdateUserByEmailApiRequest(ZulipHttpClient client, String email)	Constructs a UpdateUserByEmailApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating a user by email.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.user.request.UpdateUserApiRequest

withFullName, withNewEmail, withProfileData, withRole

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

UpdateUserByEmailApiRequest

public UpdateUserByEmailApiRequest(ZulipHttpClient client,
 String email)

Constructs a UpdateUserByEmailApiRequest.

Parameters:

client - The Zulip HTTP client

email - The email address of the user to update

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating a user by email.

Specified by:

execute in interface VoidExecutableApiRequest

Overrides:

execute in class UpdateUserApiRequest

Throws:

ZulipClientException - if the request was not successful