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

Class UpdateChannelFolderApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateChannelFolderApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for updating a channel folder.

See Also:

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
UpdateChannelFolderApiRequest(ZulipHttpClient client, int channelFolderId)	Constructs a UpdateChannelFolderApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating a channel folder.
UpdateChannelFolderApiRequest	withDescription(String description)	Sets the updated description of the channel folder.
UpdateChannelFolderApiRequest	withIsArchived(boolean isArchived)	Sets the updated archived status of the channel folder.
UpdateChannelFolderApiRequest	withName(String name)	Sets the updated name 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

IS_ARCHIVED

public static final String IS_ARCHIVED

See Also:

• Constant Field Values

Constructor Details

UpdateChannelFolderApiRequest

public UpdateChannelFolderApiRequest(ZulipHttpClient client,
 int channelFolderId)

Constructs a UpdateChannelFolderApiRequest.

Parameters:

client - The Zulip HTTP client

channelFolderId - The id of the channel folder to update

Method Details

withName

public UpdateChannelFolderApiRequest withName(String name)

Sets the updated name of the channel folder.

Parameters:

name - The updated channel folder name

Returns:

This UpdateChannelFolderApiRequest instance

withDescription

public UpdateChannelFolderApiRequest withDescription(String description)

Sets the updated description of the channel folder.

Parameters:

description - The updated channel folder name

Returns:

This UpdateChannelFolderApiRequest instance

withIsArchived

public UpdateChannelFolderApiRequest withIsArchived(boolean isArchived)

Sets the updated archived status of the channel folder.

Parameters:

isArchived - true to archive the channel folder. false to unarchive the channel folder

Returns:

This UpdateChannelFolderApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating a channel folder.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful