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

Class GetBotStorageApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Map<String,String>>

public class GetBotStorageApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Map<String,String>>

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

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEYS

Constructor Summary

Constructors

Constructor	Description
GetBotStorageApiRequest(ZulipHttpClient client)	Constructs a GetBotStorageApiRequest.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	execute()	Executes the Zulip API request for retrieving bot storage data.
GetBotStorageApiRequest	withKeys(List<String> keys)	Sets specific keys to retrieve 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

GetBotStorageApiRequest

public GetBotStorageApiRequest(ZulipHttpClient client)

Constructs a GetBotStorageApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withKeys

public GetBotStorageApiRequest withKeys(List<String> keys)

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

Parameters:

keys - The keys to retrieve

Returns:

This GetBotStorageApiRequest instance

execute

public Map<String,String> execute()
                           throws ZulipClientException

Executes the Zulip API request for retrieving bot storage data.

Specified by:

execute in interface ExecutableApiRequest<Map<String,String>>

Returns:

Map of string key-value pairs stored for the bot

Throws:

ZulipClientException - if the request was not successful