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

Class GetStreamIdApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Long>

public class GetStreamIdApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Long>

Zulip API request builder for getting the id of a stream.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STREAM

Constructor Summary

Constructors

Constructor	Description
GetStreamIdApiRequest(ZulipHttpClient client, String stream)	Constructs a GetStreamsApiRequest.

Method Summary

Modifier and Type	Method	Description
Long	execute()	Executes the Zulip API request for getting the id of 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

Field Details

STREAM

public static final String STREAM

See Also:

• Constant Field Values

Constructor Details

GetStreamIdApiRequest

public GetStreamIdApiRequest(ZulipHttpClient client,
 String stream)

Constructs a GetStreamsApiRequest.

Parameters:

client - The Zulip HTTP client

stream - The name of the stream

Method Details

execute

public Long execute()
             throws ZulipClientException

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

Specified by:

execute in interface ExecutableApiRequest<Long>

Returns:

The stream id

Throws:

ZulipClientException - if the request was not successful