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

Class RegenerateApiKeyApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<String>

public class RegenerateApiKeyApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<String>

Zulip API request builder for regenerating the current user's API key.

See Also:

• https://zulip.com/api/regenerate-api-key

Constructor Summary

Constructors

Constructor	Description
RegenerateApiKeyApiRequest(ZulipHttpClient client)	Constructs a RegenerateApiKeyApiRequest.

Method Summary

Modifier and Type	Method	Description
String	execute()	Executes the Zulip API request for regenerating the current user'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

RegenerateApiKeyApiRequest

public RegenerateApiKeyApiRequest(ZulipHttpClient client)

Constructs a RegenerateApiKeyApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public String execute()
               throws ZulipClientException

Executes the Zulip API request for regenerating the current user's API key.

Specified by:

execute in interface ExecutableApiRequest<String>

Returns:

The new API key

Throws:

ZulipClientException - if the request was not successful