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

Class GetStreamSubscribersApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<Long>>

public class GetStreamSubscribersApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<Long>>

Zulip API request builder for getting all users subscribed to a stream.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STREAM_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<Long>	execute()	Executes the Zulip API request for getting all users subscribed to 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_ID

public static final String STREAM_ID

See Also:

• Constant Field Values

Constructor Details

GetStreamSubscribersApiRequest

public GetStreamSubscribersApiRequest(ZulipHttpClient client,
 long streamId)

Constructs a GetStreamSubscribersApiRequest.

Parameters:

client - The Zulip HTTP client

streamId - The id of the stream to get subscribers for

Method Details

execute

public List<Long> execute()
                   throws ZulipClientException

Executes the Zulip API request for getting all users subscribed to a stream.

Specified by:

execute in interface ExecutableApiRequest<List<Long>>

Returns:

The list of user ids subscribed to the stream

Throws:

ZulipClientException - if the request was not successful