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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_EMPTY_TOPIC_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetStreamTopicsApiRequest	allowEmptyTopicName(boolean allowEmptyTopicName)	Sets whether an empty string as a topic name is allowed in the response.
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, putParamAsWrappedObject

Methods inherited from class java.lang.Object

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

Field Details

ALLOW_EMPTY_TOPIC_NAME

public static final String ALLOW_EMPTY_TOPIC_NAME

See Also:

• Constant Field Values

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

allowEmptyTopicName

public GetStreamTopicsApiRequest allowEmptyTopicName(boolean allowEmptyTopicName)

Sets whether an empty string as a topic name is allowed in the response.

Parameters:

allowEmptyTopicName - true to allow empty topic names. false to disallow empty topic names;

Returns:

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