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

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:

• https://zulip.com/api/get-channel-folders

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_ARCHIVED

Constructor Summary

Constructors

Constructor	Description
GetChannelFoldersApiRequest(ZulipHttpClient client)	Constructs a GetChannelFoldersApiRequest.

Method Summary

Modifier and Type	Method	Description
List<ChannelFolder>	execute()	Executes the Zulip API request for getting all channel folders.
GetChannelFoldersApiRequest	withIncludeArchived(boolean includeArchived)	Sets whether to include archived channel folders.

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_ARCHIVED

public static final String INCLUDE_ARCHIVED

See Also:

• Constant Field Values

Constructor Details

GetChannelFoldersApiRequest

public GetChannelFoldersApiRequest(ZulipHttpClient client)

Constructs a GetChannelFoldersApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withIncludeArchived

public GetChannelFoldersApiRequest withIncludeArchived(boolean includeArchived)

Sets whether to include archived channel folders.

Parameters:

includeArchived - true to include archived channel folders. false to exclude them.

Returns:

This GetChannelFoldersApiRequest instance

execute

public List<ChannelFolder> execute()
                            throws ZulipClientException

Executes the Zulip API request for getting all channel folders.

Specified by:

execute in interface ExecutableApiRequest<List<ChannelFolder>>

Returns:

The response for type T

Throws:

ZulipClientException - if the request was not successful