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

Class ArchiveStreamApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class ArchiveStreamApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deleting a topic.

See Also:

• https://zulip.com/api/archive-stream

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, 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

ArchiveStreamApiRequest

public ArchiveStreamApiRequest(ZulipHttpClient client,
 long streamId)

Constructs a ArchiveStreamApiRequest.

Parameters:

client - The Zulip HTTP client

streamId - The id of the stream to archive

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for archiving a stream.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful