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

Class GetMessageHistoryApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<MessageHistory>>

public class GetMessageHistoryApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<MessageHistory>>

Zulip API request builder for retrieving the history of a message.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_EMPTY_TOPIC_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<MessageHistory>	execute()	Executes The Zulip API request for retrieving the history of a message.
GetMessageHistoryApiRequest	withAllowEmptyTopicName(boolean allowEmptyTopicName)	Sets whether the topic names such as topic and prev_topic fields in the message_history objects returned can be an empty string.

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

ALLOW_EMPTY_TOPIC_NAME

public static final String ALLOW_EMPTY_TOPIC_NAME

See Also:

• Constant Field Values

Constructor Details

GetMessageHistoryApiRequest

public GetMessageHistoryApiRequest(ZulipHttpClient client,
 long messageId)

Constructs a GetMessageHistoryApiRequest.

Parameters:

client - The Zulip HTTP client

messageId - The id of the message to fetch history for

Method Details

withAllowEmptyTopicName

public GetMessageHistoryApiRequest withAllowEmptyTopicName(boolean allowEmptyTopicName)

Sets whether the topic names such as topic and prev_topic fields in the message_history objects returned can be an empty string.

Parameters:

allowEmptyTopicName - When true topic names such as topic and prev_topic fields in the message_history objects returned can be an empty string. When false, empty topic name strings are not allowed

Returns:

This GetMessageHistoryApiRequest instance

See Also:

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

execute

public List<MessageHistory> execute()
                             throws ZulipClientException

Executes The Zulip API request for retrieving the history of a message.

Specified by:

execute in interface ExecutableApiRequest<List<MessageHistory>>

Returns:

this list of MessageHistory items

Throws:

ZulipClientException - if the request was not successful