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

Class RemoveBotStorageApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.server.request.RemoveBotStorageApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class RemoveBotStorageApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deleting data stored for a bot user.

See Also:

• https://zulip.com/api/remove-bot-storage

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEYS

Constructor Summary

Constructors

Constructor	Description
RemoveBotStorageApiRequest(ZulipHttpClient client)	Constructs a RemoveBotStorageApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for removing bot storage data.
RemoveBotStorageApiRequest	withKeys(List<String> keys)	Sets specific keys to delete from the bot's storage.

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

KEYS

public static final String KEYS

See Also:

• Constant Field Values

Constructor Details

RemoveBotStorageApiRequest

public RemoveBotStorageApiRequest(ZulipHttpClient client)

Constructs a RemoveBotStorageApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withKeys

public RemoveBotStorageApiRequest withKeys(List<String> keys)

Sets specific keys to delete from the bot's storage. If not set, all stored data is deleted.

Parameters:

keys - The keys to delete

Returns:

This RemoveBotStorageApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for removing bot storage data.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful