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

Class GetApiKeyApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<String>

public class GetApiKeyApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<String>

Zulip API request builder for getting a user API key.

See Also:

• https://zulip.com/api/fetch-api-key
• https://zulip.com/api/dev-fetch-api-key

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PASSWORD
static final String	USERNAME

Constructor Summary

Constructors

Constructor	Description
GetApiKeyApiRequest(ZulipHttpClient client, String username)	Constructs a GetApiKeyApiRequest.
GetApiKeyApiRequest(ZulipHttpClient client, String username, String password)	Constructs a GetApiKeyApiRequest.

Method Summary

Modifier and Type	Method	Description
String	execute()	Executes the Zulip API request for getting a user API development key.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PASSWORD

public static final String PASSWORD

See Also:

• Constant Field Values

USERNAME

public static final String USERNAME

See Also:

• Constant Field Values

Constructor Details

GetApiKeyApiRequest

public GetApiKeyApiRequest(ZulipHttpClient client,
 String username)

Constructs a GetApiKeyApiRequest. To obtain an API key for development servers

Parameters:

client - The Zulip HTTP client

username - The username to fetch the development API key for

GetApiKeyApiRequest

public GetApiKeyApiRequest(ZulipHttpClient client,
 String username,
 String password)

Constructs a GetApiKeyApiRequest. To obtain an API key for production servers

Parameters:

client - The Zulip HTTP client

username - The username to fetch the development API key for

password - The password to fetch the development API key for

Method Details

execute

public String execute()
               throws ZulipClientException

Executes the Zulip API request for getting a user API development key.

Specified by:

execute in interface ExecutableApiRequest<String>

Returns:

The users API development key

Throws:

ZulipClientException - if the request was not successful