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:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionRenderMessageApiRequest(ZulipHttpClient client, String content) Constructs aRenderMessageApiRequest. -
Method Summary
Modifier and TypeMethodDescriptionexecute()Executes the Zulip API request for rendering message to HTML.withPopulateUrlEmbedData(boolean populateUrlEmbedData) Sets whether the server should populate URL embed data for links in the content.Methods inherited from class ZulipApiRequest
client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject
-
Field Details
-
CONTENT
- See Also:
-
POPULATE_URL_EMBED_DATA
- See Also:
-
-
Constructor Details
-
RenderMessageApiRequest
Constructs aRenderMessageApiRequest.- Parameters:
client- The Zulip HTTP clientcontent- The content of the message to render as HTML
-
-
Method Details
-
withPopulateUrlEmbedData
Sets whether the server should populate URL embed data for links in the content. Data the server already has is included in the rendered content. The rest is fetched asynchronously and delivered via aurl_embed_dataevent.- Parameters:
populateUrlEmbedData-trueto populate URL embed data for the content's links- Returns:
- This
RenderMessageApiRequestinstance - See Also:
-
execute
Executes the Zulip API request for rendering message to HTML.- Specified by:
executein interfaceExecutableApiRequest<String>- Returns:
- The rendered message HTML
- Throws:
ZulipClientException- if the request was not successful
-