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

Class GetStreamTopicsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<Topic>>

public class GetStreamTopicsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<Topic>>

Zulip API request builder for getting stream topics.

See Also:

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<Topic>	execute()	Executes the Zulip API request for getting stream topic.

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

GetStreamTopicsApiRequest

public GetStreamTopicsApiRequest(ZulipHttpClient client,
 long streamId)

Constructs a GetStreamTopicsApiResponse.

Parameters:

client - The Zulip HTTP client

streamId - The id of the stream to get topics from

Method Details

execute

public List<Topic> execute()
                    throws ZulipClientException

Executes the Zulip API request for getting stream topic.

Specified by:

execute in interface ExecutableApiRequest<List<Topic>>

Returns:

List of Topic objects

Throws:

ZulipClientException - if the request was not successful