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

Class GetMessageReadReceiptsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<Long>>

public class GetMessageReadReceiptsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<Long>>

Zulip API request builder for getting a list containing of IDs for all users who have marked the given message as read.

See Also:

• https://zulip.com/api/get-read-receipts

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<Long>	execute()	Executes the Zulip API request for getting message receipts.

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

MESSAGE_ID

public static final String MESSAGE_ID

See Also:

• Constant Field Values

Constructor Details

GetMessageReadReceiptsApiRequest

public GetMessageReadReceiptsApiRequest(ZulipHttpClient client,
 long messageId)

Constructs a GetMessageReadReceiptsApiRequest.

Parameters:

client - The Zulip HTTP client

messageId - The id of the message to get read recipients for

Method Details

execute

public List<Long> execute()
                   throws ZulipClientException

Executes the Zulip API request for getting message receipts.

Specified by:

execute in interface ExecutableApiRequest<List<Long>>

Returns:

List of user ids who have marked the target message as read

Throws:

ZulipClientException - if the request was not successful