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

Class DeleteStreamApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class DeleteStreamApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deleting a stream.

See Also:

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for deleting 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

DeleteStreamApiRequest

public DeleteStreamApiRequest(ZulipHttpClient client,
 long streamId)

Constructs a DeleteStreamApiRequest.

Parameters:

client - The Zulip HTTP client

streamId - The id of the stream to delete

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for deleting a stream.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful