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

Class RenderMessageApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.message.request.RenderMessageApiRequest

All Implemented Interfaces:

ExecutableApiRequest<String>

public class RenderMessageApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<String>

Zulip API request builder for rendering message to HTML.

See Also:

• https://zulip.com/api/render-message

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT

Constructor Summary

Constructors

Constructor	Description
RenderMessageApiRequest(ZulipHttpClient client, String content)	Constructs a RenderMessageApiRequest.

Method Summary

Modifier and Type	Method	Description
String	execute()	Executes the Zulip API request for rendering message to HTML.

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

client, 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

CONTENT

public static final String CONTENT

See Also:

• Constant Field Values

Constructor Details

RenderMessageApiRequest

public RenderMessageApiRequest(ZulipHttpClient client,
 String content)

Constructs a RenderMessageApiRequest.

Parameters:

client - The Zulip HTTP client

content - The content of the message to render as HTML

Method Details

execute

public String execute()
               throws ZulipClientException

Executes the Zulip API request for rendering message to HTML.

Specified by:

execute in interface ExecutableApiRequest<String>

Returns:

The rendered message HTML

Throws:

ZulipClientException - if the request was not successful