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

Class GetAllUsersApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<User>>

public class GetAllUsersApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<User>>

Zulip API request builder for getting all users.

See Also:

• https://zulip.com/api/get-users

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_GRAVATAR
static final String	INCLUDE_CUSTOM_PROFILE_FIELDS
static final String	USER_IDS

Constructor Summary

Constructors

Constructor	Description
GetAllUsersApiRequest(ZulipHttpClient client)	Constructs a GetAllUsersApiRequest.

Method Summary

Modifier and Type	Method	Description
List<User>	execute()	Executes the Zulip API request for getting all users.
GetAllUsersApiRequest	withClientGravatar(boolean gravatar)	Sets whether to include the user gravatar image URL in the response.
GetAllUsersApiRequest	withIncludeCustomProfileFields(boolean includeCustomProfileFields)	Sets whether to include the user custom profile fields in the response.
GetAllUsersApiRequest	withUserIds(Long... userIds)	Limits the response to users in the given list.

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

CLIENT_GRAVATAR

public static final String CLIENT_GRAVATAR

See Also:

• Constant Field Values

INCLUDE_CUSTOM_PROFILE_FIELDS

public static final String INCLUDE_CUSTOM_PROFILE_FIELDS

See Also:

• Constant Field Values

USER_IDS

public static final String USER_IDS

See Also:

• Constant Field Values

Constructor Details

GetAllUsersApiRequest

public GetAllUsersApiRequest(ZulipHttpClient client)

Constructs a GetAllUsersApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withClientGravatar

public GetAllUsersApiRequest withClientGravatar(boolean gravatar)

Sets whether to include the user gravatar image URL in the response.

Parameters:

gravatar - true to include the gravatar image URL in the response. false to not include the gravatar image URL in the response

Returns:

This GetAllUsersApiRequest instance

See Also:

• https://zulip.com/api/get-users#parameter-client_gravatar

withIncludeCustomProfileFields

public GetAllUsersApiRequest withIncludeCustomProfileFields(boolean includeCustomProfileFields)

Sets whether to include the user custom profile fields in the response.

Parameters:

includeCustomProfileFields - true to include user custom profile fields in the response. false to not include user custom profile fields in the response

Returns:

This GetAllUsersApiRequest instance

See Also:

• https://zulip.com/api/get-users#parameter-include_custom_profile_fields

withUserIds

public GetAllUsersApiRequest withUserIds(Long... userIds)

Limits the response to users in the given list.

Parameters:

userIds - The user ids to limit the response to

Returns:

This GetAllUsersApiRequest instance

See Also:

• https://zulip.com/api/get-users#parameter-user_ids

execute

public List<User> execute()
                   throws ZulipClientException

Executes the Zulip API request for getting all users.

Specified by:

execute in interface ExecutableApiRequest<List<User>>

Returns:

List of User objects

Throws:

ZulipClientException - if the request was not successful