Class GetChannelFoldersApiRequest
java.lang.Object
com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest
com.github.jamesnetherton.zulip.client.api.channel.request.GetChannelFoldersApiRequest
- All Implemented Interfaces:
ExecutableApiRequest<List<ChannelFolder>>
public class GetChannelFoldersApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<ChannelFolder>>
Zulip API request builder for getting all channel folders.
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexecute()Executes the Zulip API request for getting all channel folders.withIncludeArchived(boolean includeArchived) Sets whether to include archived channel folders.Methods inherited from class ZulipApiRequest
client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject
-
Field Details
-
INCLUDE_ARCHIVED
- See Also:
-
-
Constructor Details
-
GetChannelFoldersApiRequest
Constructs aGetChannelFoldersApiRequest.- Parameters:
client- The Zulip HTTP client
-
-
Method Details
-
withIncludeArchived
Sets whether to include archived channel folders.- Parameters:
includeArchived-trueto include archived channel folders.falseto exclude them.- Returns:
- This
GetChannelFoldersApiRequestinstance
-
execute
Executes the Zulip API request for getting all channel folders.- Specified by:
executein interfaceExecutableApiRequest<List<ChannelFolder>>- Returns:
- The response for type T
- Throws:
ZulipClientException- if the request was not successful
-