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

Class GetUserChannelsApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.GetUserChannelsApiRequest

All Implemented Interfaces:

ExecutableApiRequest<List<Long>>

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

Zulip API request builder for getting the list of channels a user is subscribed to.

See Also:

• https://zulip.com/api/get-user-channels

Constructor Summary

Constructors

Constructor	Description
GetUserChannelsApiRequest(ZulipHttpClient client, long userId)	Constructs a GetUserChannelsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<Long>	execute()	Executes the Zulip API request for getting a user's subscribed channels.

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

Constructor Details

GetUserChannelsApiRequest

public GetUserChannelsApiRequest(ZulipHttpClient client,
 long userId)

Constructs a GetUserChannelsApiRequest.

Parameters:

client - The Zulip HTTP client

userId - The ID of the user to get channels for

Method Details

execute

public List<Long> execute()
                   throws ZulipClientException

Executes the Zulip API request for getting a user's subscribed channels.

Specified by:

execute in interface ExecutableApiRequest<List<Long>>

Returns:

List of channel IDs the user is subscribed to

Throws:

ZulipClientException - if the request was not successful