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

Class MuteTopicApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.stream.request.MuteTopicApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class MuteTopicApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for muting or unmuting a topic.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPERATION
static final String	STREAM
static final String	STREAM_ID
static final String	TOPIC

Constructor Summary

Constructors

Constructor	Description
MuteTopicApiRequest(ZulipHttpClient client, String topic, Operation operation)	Constructs a MuteTopicApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for muting or unmuting a topic.
MuteTopicApiRequest	withStream(String stream)	Sets the name of the stream where the topic resides.
MuteTopicApiRequest	withStreamId(long streamId)	Sets the id of the stream where the topic resides.

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

OPERATION

public static final String OPERATION

See Also:

• Constant Field Values

STREAM

public static final String STREAM

See Also:

• Constant Field Values

STREAM_ID

public static final String STREAM_ID

See Also:

• Constant Field Values

TOPIC

public static final String TOPIC

See Also:

• Constant Field Values

Constructor Details

MuteTopicApiRequest

public MuteTopicApiRequest(ZulipHttpClient client,
 String topic,
 Operation operation)

Constructs a MuteTopicApiRequest.

Parameters:

client - The Zulip HTTP client

topic - The name of the topic to mute or unmute

operation - The Operation to apply. Operation.ADD to mute the topic or Operation.REMOVE to unmute the topic

Method Details

withStream

public MuteTopicApiRequest withStream(String stream)

Sets the name of the stream where the topic resides.

Parameters:

stream - The name of the stream where the topic resides

Returns:

This MuteTopicApiRequest instance

withStreamId

public MuteTopicApiRequest withStreamId(long streamId)

Sets the id of the stream where the topic resides.

Parameters:

streamId - The id of the stream where the topic resides

Returns:

This MuteTopicApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for muting or unmuting a topic.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful