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

Class GetStreamApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Stream>

public class GetStreamApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Stream>

Zulip API request builder for getting a stream by id.

See Also:

• https://zulip.com/api/get-stream-by-id

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Stream	execute()	Executes the Zulip API request for getting a stream by id.

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

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GetStreamApiRequest

public GetStreamApiRequest(ZulipHttpClient client,
 long streamId)

Constructs a GetStreamApiRequest.

Parameters:

client - The Zulip HTTP client

streamId - The id of the stream to get

Method Details

execute

public Stream execute()
               throws ZulipClientException

Executes the Zulip API request for getting a stream by id.

Specified by:

execute in interface ExecutableApiRequest<Stream>

Returns:

The stream matching the provided stream id

Throws:

ZulipClientException - if the request was not successful