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

Class GetMessageApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Message>

public class GetMessageApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Message>

Zulip API request builder for getting a single message.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLY_MARKDOWN

Constructor Summary

Constructors

Constructor	Description
GetMessageApiRequest(ZulipHttpClient client, long messageId)	Constructs a GetMessageApiRequest.

Method Summary

Modifier and Type	Method	Description
Message	execute()	Executes the Zulip API request for getting raw content from a message.
GetMessageApiRequest	withApplyMarkdown(boolean applyMarkdown)	Sets whether message content is returned in its raw markdown format.

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

APPLY_MARKDOWN

public static final String APPLY_MARKDOWN

See Also:

• Constant Field Values

Constructor Details

GetMessageApiRequest

public GetMessageApiRequest(ZulipHttpClient client,
 long messageId)

Constructs a GetMessageApiRequest.

Parameters:

client - The Zulip HTTP client

messageId - The id of the message to get

Method Details

withApplyMarkdown

public GetMessageApiRequest withApplyMarkdown(boolean applyMarkdown)

Sets whether message content is returned in its raw markdown format.

Parameters:

applyMarkdown - If true, message content is returned in the rendered HTML format. If false, message content is returned in the raw Markdown-format text that user entered.

Returns:

This GetMessageApiRequest instance

See Also:

• https://zulip.com/api/get-message#parameter-apply_markdown

execute

public Message execute()
                throws ZulipClientException

Executes the Zulip API request for getting raw content from a message.

Specified by:

execute in interface ExecutableApiRequest<Message>

Returns:

The message

Throws:

ZulipClientException - if the request was not successful