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

Class UpdateUserTopicPreferencesApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateUserTopicPreferencesApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for updating user topic preferences.

See Also:

• https://zulip.com/api/update-user-topic

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STREAM_ID
static final String	TOPIC
static final String	VISIBILITY_POLICY

Constructor Summary

Constructors

Constructor	Description
UpdateUserTopicPreferencesApiRequest(ZulipHttpClient client, long streamId, String topic, TopicVisibilityPolicy topicVisibilityPolicy)	Constructs a UpdateUserTopicPreferencesApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updatig user topic preferences.

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

STREAM_ID

public static final String STREAM_ID

See Also:

• Constant Field Values

TOPIC

public static final String TOPIC

See Also:

• Constant Field Values

VISIBILITY_POLICY

public static final String VISIBILITY_POLICY

See Also:

• Constant Field Values

Constructor Details

UpdateUserTopicPreferencesApiRequest

public UpdateUserTopicPreferencesApiRequest(ZulipHttpClient client,
 long streamId,
 String topic,
 TopicVisibilityPolicy topicVisibilityPolicy)

Constructs a UpdateUserTopicPreferencesApiRequest.

Parameters:

client - The Zulip HTTP client

streamId - The id of the stream where the topic resides

topic - The name of the topic to update preferences for

topicVisibilityPolicy - The TopicVisibilityPolicy to apply

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updatig user topic preferences.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful