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

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_MUTED_WITH_ID;

import com.github.jamesnetherton.zulip.client.api.core.VoidExecutableApiRequest;
import com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest;
import com.github.jamesnetherton.zulip.client.api.core.ZulipApiResponse;
import com.github.jamesnetherton.zulip.client.exception.ZulipClientException;
import com.github.jamesnetherton.zulip.client.http.ZulipHttpClient;

/**
 * Zulip API request builder for muting a user.
 *
 * @see https://zulip.com/api/mute-user
 */
public class MuteUserApiRequest extends ZulipApiRequest implements VoidExecutableApiRequest {

    private final String path;

    /**
     * Constructs a {@link MuteUserApiRequest}.
     *
     * @param client The Zulip HTTP client
     * @param userId The ID of the user to mute
     */
    public MuteUserApiRequest(ZulipHttpClient client, long userId) {
        super(client);
        this.path = String.format(USERS_MUTED_WITH_ID, userId);
    }

    /**
     * Executes the Zulip API request for muting a user.
     *
     * @throws ZulipClientException if the request was not successful
     */
    @Override
    public void execute() throws ZulipClientException {
        client().post(path, getParams(), ZulipApiResponse.class);
    }
}