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

Class CreateMessageReminderApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Integer>

public class CreateMessageReminderApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Integer>

Zulip API request builder for creating a message reminder.

See Also:

• https://zulip.com/api/create-message-reminder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE_ID
static final String	NOTE
static final String	SCHEDULED_DELIVERY_TIMESTAMP

Constructor Summary

Constructors

Constructor	Description
CreateMessageReminderApiRequest(ZulipHttpClient client, long messageId, Instant scheduledDeliveryTimestamp)	Constructs a CreateMessageReminderApiRequest.

Method Summary

Modifier and Type	Method	Description
Integer	execute()	Executes the Zulip API request for creating a message reminder.
CreateMessageReminderApiRequest	withNote(String note)	Sets the note associated with the reminder shown in the Notification Bot message.

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

NOTE

public static final String NOTE

See Also:

• Constant Field Values

SCHEDULED_DELIVERY_TIMESTAMP

public static final String SCHEDULED_DELIVERY_TIMESTAMP

See Also:

• Constant Field Values

Constructor Details

CreateMessageReminderApiRequest

public CreateMessageReminderApiRequest(ZulipHttpClient client,
 long messageId,
 Instant scheduledDeliveryTimestamp)

Constructs a CreateMessageReminderApiRequest.

Parameters:

client - The Zulip HTTP client

messageId - The id of the previously sent message to reference in the message reminder

scheduledDeliveryTimestamp - The timestamp for when the message reminder will be sent

Method Details

withNote

public CreateMessageReminderApiRequest withNote(String note)

Sets the note associated with the reminder shown in the Notification Bot message.

Parameters:

note - The reminder note

Returns:

This CreateMessageReminderApiRequest instance

See Also:

• https://zulip.com/api/create-message-reminder#parameter-note

execute

public Integer execute()
                throws ZulipClientException

Executes the Zulip API request for creating a message reminder.

Specified by:

execute in interface ExecutableApiRequest<Integer>

Returns:

The id of the created message reminder

Throws:

ZulipClientException - if the request was not successful