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

Class JwtFetchApiKeyApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<JwtFetchApiKeyResponse>

public class JwtFetchApiKeyApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<JwtFetchApiKeyResponse>

Zulip API request builder for fetching an API key using a JWT token.

See Also:

• https://zulip.com/api/jwt-fetch-api-key#usage-examples

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_PROFILE
static final String	TOKEN

Constructor Summary

Constructors

Constructor	Description
JwtFetchApiKeyApiRequest(ZulipHttpClient client, String token)	Constructs a JwtFetchApiKeyApiRequest.

Method Summary

Modifier and Type	Method	Description
JwtFetchApiKeyResponse	execute()	Executes the Zulip API request for fetching an API key using a JWT token.
JwtFetchApiKeyApiRequest	withIncludeProfile(boolean includeProfile)	Sets whether to include the user profile data in the response.

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

TOKEN

public static final String TOKEN

See Also:

• Constant Field Values

INCLUDE_PROFILE

public static final String INCLUDE_PROFILE

See Also:

• Constant Field Values

Constructor Details

JwtFetchApiKeyApiRequest

public JwtFetchApiKeyApiRequest(ZulipHttpClient client,
 String token)

Constructs a JwtFetchApiKeyApiRequest.

Parameters:

client - The Zulip HTTP client

token - The JWT token

Method Details

withIncludeProfile

public JwtFetchApiKeyApiRequest withIncludeProfile(boolean includeProfile)

Sets whether to include the user profile data in the response.

Parameters:

includeProfile - true to include the user profile data in the response. false to not include the user profile data in the response

Returns:

This JwtFetchApiKeyApiRequest instance

execute

public JwtFetchApiKeyResponse execute()
                               throws ZulipClientException

Executes the Zulip API request for fetching an API key using a JWT token.

Specified by:

execute in interface ExecutableApiRequest<JwtFetchApiKeyResponse>

Returns:

JwtFetchApiKeyResponse containing the API key, email and optionally user data

Throws:

ZulipClientException - if the request was not successful