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

Class UpdateBotStorageApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateBotStorageApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for adding or updating data stored for a bot user.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STORAGE

Constructor Summary

Constructors

Constructor	Description
UpdateBotStorageApiRequest(ZulipHttpClient client, Map<String,String> storage)	Constructs an UpdateBotStorageApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating bot storage data.

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

STORAGE

public static final String STORAGE

See Also:

• Constant Field Values

Constructor Details

UpdateBotStorageApiRequest

public UpdateBotStorageApiRequest(ZulipHttpClient client,
 Map<String,String> storage)

Constructs an UpdateBotStorageApiRequest.

Parameters:

client - The Zulip HTTP client

storage - Map of string key-value pairs to store for the bot

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating bot storage data.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful