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

Class CreateUserApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Long>

public class CreateUserApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Long>

Zulip API request builder for creating a new user.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMAIL
static final String	FULL_NAME
static final String	PASSWORD

Constructor Summary

Constructors

Constructor	Description
CreateUserApiRequest(ZulipHttpClient client, String email, String fullName, String password)	Constructs a CreateUserApiRequest.

Method Summary

Modifier and Type	Method	Description
Long	execute()	Executes the Zulip API request for creating a new user.

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

client, 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

EMAIL

public static final String EMAIL

See Also:

• Constant Field Values

FULL_NAME

public static final String FULL_NAME

See Also:

• Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

• Constant Field Values

Constructor Details

CreateUserApiRequest

public CreateUserApiRequest(ZulipHttpClient client,
 String email,
 String fullName,
 String password)

Constructs a CreateUserApiRequest.

Parameters:

client - The Zulip HTTP client

email - The email address of the new user

fullName - The name of the new user

password - The password of the new user

Method Details

execute

public Long execute()
             throws ZulipClientException

Executes the Zulip API request for creating a new user.

Specified by:

execute in interface ExecutableApiRequest<Long>

Returns:

The id of the new user

Throws:

ZulipClientException - if the request was not successful