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

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.

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

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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