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

Class TestWelcomeBotCustomMessageApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Integer>

public class TestWelcomeBotCustomMessageApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Integer>

Zulip API request builder for testing the welcome bot custom message.

See Also:

• https://zulip.com/api/test-welcome-bot-custom-message

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WELCOME_MESSAGE_CUSTOM_TEXT

Constructor Summary

Constructors

Constructor	Description
TestWelcomeBotCustomMessageApiRequest(ZulipHttpClient client, String welcomeMessageCustomTest)	Constructs a TestWelcomeBotCustomMessageApiRequest.

Method Summary

Modifier and Type	Method	Description
Integer	execute()	Executes the Zulip API request for testing the welcome bot custom message.

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

WELCOME_MESSAGE_CUSTOM_TEXT

public static final String WELCOME_MESSAGE_CUSTOM_TEXT

See Also:

• Constant Field Values

Constructor Details

TestWelcomeBotCustomMessageApiRequest

public TestWelcomeBotCustomMessageApiRequest(ZulipHttpClient client,
 String welcomeMessageCustomTest)

Constructs a TestWelcomeBotCustomMessageApiRequest.

Parameters:

client - The Zulip HTTP client

welcomeMessageCustomTest - The custom welcome message content

Method Details

execute

public Integer execute()
                throws ZulipClientException

Executes the Zulip API request for testing the welcome bot custom message.

Specified by:

execute in interface ExecutableApiRequest<Integer>

Returns:

The response for type T

Throws:

ZulipClientException - if the request was not successful