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

Class AddCodePlaygroundApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Long>

public class AddCodePlaygroundApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Long>

Zulip API request builder for adding a code playground.

See Also:

• https://zulip.com/api/add-code-playground

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final String	PYGMENTS_LANGUAGE
static final String	URL_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
AddCodePlaygroundApiRequest(ZulipHttpClient client, String name, String pygmentsLanguage, String urlTemplate)	Constructs a AddCodePlaygroundApiRequest.

Method Summary

Modifier and Type	Method	Description
Long	execute()	Executes the Zulip API request for adding a code playground.

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

NAME

public static final String NAME

See Also:

• Constant Field Values

PYGMENTS_LANGUAGE

public static final String PYGMENTS_LANGUAGE

See Also:

• Constant Field Values

URL_TEMPLATE

public static final String URL_TEMPLATE

See Also:

• Constant Field Values

Constructor Details

AddCodePlaygroundApiRequest

public AddCodePlaygroundApiRequest(ZulipHttpClient client,
 String name,
 String pygmentsLanguage,
 String urlTemplate)

Constructs a AddCodePlaygroundApiRequest.

Parameters:

client - The Zulip HTTP client

name - The name of the playground

pygmentsLanguage - The name of the Pygments language lexer for that programming language

urlTemplate - The URL template for the playground

Method Details

execute

public Long execute()
             throws ZulipClientException

Executes the Zulip API request for adding a code playground.

Specified by:

execute in interface ExecutableApiRequest<Long>

Returns:

The response for type T

Throws:

ZulipClientException - if the request was not successful