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

Class CreateChannelFolderApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Integer>

public class CreateChannelFolderApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Integer>

Zulip API request builder for creating new channel folder.

See Also:

• https://zulip.com/api/create-channel-folder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
CreateChannelFolderApiRequest(ZulipHttpClient client, String name)	Constructs a CreateChannelFolderApiRequest.

Method Summary

Modifier and Type	Method	Description
Integer	execute()	Executes the Zulip API request for creating a channel folder.
CreateChannelFolderApiRequest	withDescription(String description)	Sets the description of the channel folder.

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

NAME

public static final String NAME

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

Constructor Details

CreateChannelFolderApiRequest

public CreateChannelFolderApiRequest(ZulipHttpClient client,
 String name)

Constructs a CreateChannelFolderApiRequest.

Parameters:

client - The Zulip HTTP client

name - The name of the channel folder

Method Details

withDescription

public CreateChannelFolderApiRequest withDescription(String description)

Sets the description of the channel folder.

Parameters:

description - The description for the channel folder

Returns:

This CreateChannelFolderApiRequest instance

See Also:

• https://zulip.com/api/create-channel-folder#parameter-description

execute

public Integer execute()
                throws ZulipClientException

Executes the Zulip API request for creating a channel folder.

Specified by:

execute in interface ExecutableApiRequest<Integer>

Returns:

The response for type T

Throws:

ZulipClientException - if the request was not successful