com.github.jamesnetherton.zulip.client.api.user.request.GetAllUsersApiRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zulip-java-client Show documentation
Java client for the Zulip REST API
The newest version!
package com.github.jamesnetherton.zulip.client.api.user.request;

import static com.github.jamesnetherton.zulip.client.api.user.request.UserRequestConstants.USERS;

import com.github.jamesnetherton.zulip.client.api.core.ExecutableApiRequest;
import com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest;
import com.github.jamesnetherton.zulip.client.api.user.User;
import com.github.jamesnetherton.zulip.client.api.user.response.GetAllUsersApiResponse;
import com.github.jamesnetherton.zulip.client.exception.ZulipClientException;
import com.github.jamesnetherton.zulip.client.http.ZulipHttpClient;
import java.util.ArrayList;
import java.util.List;

/**
 * Zulip API request builder for getting all users.
 *
 * @see https://zulip.com/api/get-users
 */
public class GetAllUsersApiRequest extends ZulipApiRequest implements ExecutableApiRequest> {

    public static final String CLIENT_GRAVATAR = "client_gravatar";
    public static final String INCLUDE_CUSTOM_PROFILE_FIELDS = "include_custom_profile_fields";

    /**
     * Constructs a {@link GetAllUsersApiRequest}.
     *
     * @param client The Zulip HTTP client
     */
    public GetAllUsersApiRequest(ZulipHttpClient client) {
        super(client);
    }

    /**
     * Sets whether to include the user gravatar image URL in the response.
     *
     * @param  gravatar {@code true} to include the gravatar image URL in the response. {@code false} to not include the
     *                  gravatar image URL in the response
     * @return          This {@link GetAllUsersApiRequest} instance
     */
    public GetAllUsersApiRequest withClientGravatar(boolean gravatar) {
        putParam(CLIENT_GRAVATAR, gravatar);
        return this;
    }

    /**
     * Sets whether to include the user custom profile fields in the response.
     *
     * @param  includeCustomProfileFields {@code true} to include user custom profile fields in the response. {@code false} to
     *                                    not include user custom profile fields in the response
     * @return                            This {@link GetAllUsersApiRequest} instance
     */
    public GetAllUsersApiRequest withIncludeCustomProfileFields(boolean includeCustomProfileFields) {
        putParam(INCLUDE_CUSTOM_PROFILE_FIELDS, includeCustomProfileFields);
        return this;
    }

    /**
     * Executes the Zulip API request for getting all users.
     *
     * @return                      List of {@link User} objects
     * @throws ZulipClientException if the request was not successful
     */
    @Override
    public List execute() throws ZulipClientException {
        List users = new ArrayList<>();
        GetAllUsersApiResponse response = client().get(USERS, getParams(), GetAllUsersApiResponse.class);
        response.getMembers()
                .stream()
                .map(User::new)
                .forEach(users::add);
        return users;
    }
}