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

Class GetSubscribedStreamsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<StreamSubscription>>

public class GetSubscribedStreamsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<StreamSubscription>>

Zulip API request builder for getting streams that the user is subscribed to.

See Also:

• https://zulip.com/api/get-subscriptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_SUBSCRIBERS

Constructor Summary

Constructors

Constructor	Description
GetSubscribedStreamsApiRequest(ZulipHttpClient client)	Constructs a GetSubscribedStreamsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<StreamSubscription>	execute()	Executes the Zulip API request for getting streams that the user is subscribed to.
GetSubscribedStreamsApiRequest	withIncludePartialSubscribers()	Sets whether the response should include a list of partial subscriber user ids.
GetSubscribedStreamsApiRequest	withIncludeSubscribers(boolean includeSubscribers)	Sets whether the response should include a list of subscriber user ids.

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

client, getParam, 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

INCLUDE_SUBSCRIBERS

public static final String INCLUDE_SUBSCRIBERS

See Also:

• Constant Field Values

Constructor Details

GetSubscribedStreamsApiRequest

public GetSubscribedStreamsApiRequest(ZulipHttpClient client)

Constructs a GetSubscribedStreamsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withIncludeSubscribers

public GetSubscribedStreamsApiRequest withIncludeSubscribers(boolean includeSubscribers)

Sets whether the response should include a list of subscriber user ids.

Parameters:

includeSubscribers - true for the response to include a list of subscriber user ids. false for the response to include an empty list of subscriber user id.

Returns:

This GetSubscribedStreamsApiRequest instance

withIncludePartialSubscribers

public GetSubscribedStreamsApiRequest withIncludePartialSubscribers()

Sets whether the response should include a list of partial subscriber user ids. Note that this overrides the value set from withIncludePartialSubscribers().

Returns:

This GetSubscribedStreamsApiRequest instance

execute

public List<StreamSubscription> execute()
                                 throws ZulipClientException

Executes the Zulip API request for getting streams that the user is subscribed to.

Specified by:

execute in interface ExecutableApiRequest<List<StreamSubscription>>

Returns:

List of StreamSubscription objects

Throws:

ZulipClientException - if the request was not successful