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

Class GetBotApiKeyApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.GetBotApiKeyApiRequest

All Implemented Interfaces:

ExecutableApiRequest<String>

public class GetBotApiKeyApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<String>

Zulip API request builder for fetching the API key of a bot user.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
GetBotApiKeyApiRequest(ZulipHttpClient client, long botId)	Constructs a GetBotApiKeyApiRequest.

Method Summary

Modifier and Type	Method	Description
String	execute()	Executes the Zulip API request for fetching a bot's API key.

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

Constructor Details

GetBotApiKeyApiRequest

public GetBotApiKeyApiRequest(ZulipHttpClient client,
 long botId)

Constructs a GetBotApiKeyApiRequest.

Parameters:

client - The Zulip HTTP client

botId - The user ID of the target bot

Method Details

execute

public String execute()
               throws ZulipClientException

Executes the Zulip API request for fetching a bot's API key.

Specified by:

execute in interface ExecutableApiRequest<String>

Returns:

The API key for the bot

Throws:

ZulipClientException - if the request was not successful