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

Class MuteUserApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class MuteUserApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for muting a user.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
MuteUserApiRequest(ZulipHttpClient client, long userId)	Constructs a MuteUserApiRequest.

Method Summary

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

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

MuteUserApiRequest

public MuteUserApiRequest(ZulipHttpClient client,
 long userId)

Constructs a MuteUserApiRequest.

Parameters:

client - The Zulip HTTP client

userId - The ID of the user to mute

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for muting a user.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful