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
Zulip API request builder for deleting data stored for a bot user.
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidexecute()Executes the Zulip API request for removing bot storage data.Sets specific keys to delete from the bot's storage.Methods inherited from class ZulipApiRequest
client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject
-
Field Details
-
KEYS
- See Also:
-
-
Constructor Details
-
RemoveBotStorageApiRequest
Constructs aRemoveBotStorageApiRequest.- Parameters:
client- The Zulip HTTP client
-
-
Method Details
-
withKeys
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
RemoveBotStorageApiRequestinstance
-
execute
Executes the Zulip API request for removing bot storage data.- Specified by:
executein interfaceVoidExecutableApiRequest- Throws:
ZulipClientException- if the request was not successful
-