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

Class MarkStreamAsReadApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.message.request.MarkStreamAsReadApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class MarkStreamAsReadApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for marking a stream as read.

See Also:

• https://zulip.com/api/mark-all-as-read#mark-messages-in-a-stream-as-read

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STREAM_ID

Constructor Summary

Constructors

Constructor	Description
MarkStreamAsReadApiRequest(ZulipHttpClient client, long streamId)	Constructs a MarkStreamAsReadApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for marking a stream as read.

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

Constructor Details

MarkStreamAsReadApiRequest

public MarkStreamAsReadApiRequest(ZulipHttpClient client,
 long streamId)

Constructs a MarkStreamAsReadApiRequest.

Parameters:

client - The Zulip HTTP client

streamId - The id of the stream to mark as read

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for marking a stream as read.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful