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

Class EditScheduledMessageApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class EditScheduledMessageApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for editing a scheduled message.

See Also:

• https://zulip.com/api/update-scheduled-message

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT
static final String	SCHEDULED_DELIVERY_TIMESTAMP
static final String	TO
static final String	TOPIC
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
EditScheduledMessageApiRequest(ZulipHttpClient client, long scheduledMessageId)	Constructs a EditScheduledMessageApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Invokes the HTTP client to send the request to the Zulip REST API.
EditScheduledMessageApiRequest	withContent(String content)	Sets the topic of the message.
EditScheduledMessageApiRequest	withScheduledDeliveryTimestamp(Instant scheduledDeliveryTimestamp)	Sets the UNIX epoch timestamp for when the message will be sent.
EditScheduledMessageApiRequest	withTo(long... to)	Sets the id of the stream, or one or more user ids to send the scheduled message to.
EditScheduledMessageApiRequest	withTopic(String topic)	Sets the topic of the message.
EditScheduledMessageApiRequest	withType(MessageType type)	Sets the type of scheduled message to be sent

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

client, 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

CONTENT

public static final String CONTENT

See Also:

• Constant Field Values

SCHEDULED_DELIVERY_TIMESTAMP

public static final String SCHEDULED_DELIVERY_TIMESTAMP

See Also:

• Constant Field Values

TO

public static final String TO

See Also:

• Constant Field Values

TOPIC

public static final String TOPIC

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

EditScheduledMessageApiRequest

public EditScheduledMessageApiRequest(ZulipHttpClient client,
 long scheduledMessageId)

Constructs a EditScheduledMessageApiRequest.

Parameters:

client - The Zulip HTTP client

scheduledMessageId - The id of the scheduled message to edit

Method Details

withContent

public EditScheduledMessageApiRequest withContent(String content)

Sets the topic of the message. Only required if 'type' is 'stream'.

Parameters:

content - The content of the message

Returns:

This EditScheduledMessageApiRequest instance

See Also:

• https://zulip.com/api/update-scheduled-message#parameter-topic

withScheduledDeliveryTimestamp

public EditScheduledMessageApiRequest withScheduledDeliveryTimestamp(Instant scheduledDeliveryTimestamp)

Sets the UNIX epoch timestamp for when the message will be sent.

Parameters:

scheduledDeliveryTimestamp - Instant set to the UNIX epoch timestamp for when the message will be sent

Returns:

This EditScheduledMessageApiRequest instance

See Also:

• https://zulip.com/api/update-scheduled-message#parameter-topic

withTo

public EditScheduledMessageApiRequest withTo(long... to)

Sets the id of the stream, or one or more user ids to send the scheduled message to.

Parameters:

to - If the type is 'stream' then this is the id of the stream. Else one or more user ids may be specified

Returns:

This EditScheduledMessageApiRequest instance

See Also:

• https://zulip.com/api/update-scheduled-message#parameter-topic

withTopic

public EditScheduledMessageApiRequest withTopic(String topic)

Sets the topic of the message. Only required if 'type' is 'stream'.

Parameters:

topic - The topic that the scheduled message should be sent to

Returns:

This EditScheduledMessageApiRequest instance

See Also:

• https://zulip.com/api/update-scheduled-message#parameter-topic

withType

public EditScheduledMessageApiRequest withType(MessageType type)

Sets the type of scheduled message to be sent

Parameters:

type - The type of scheduled message to be sent

Returns:

This EditScheduledMessageApiRequest instance

See Also:

• https://zulip.com/api/update-scheduled-message#parameter-topic

execute

public void execute()
             throws ZulipClientException

Description copied from interface: VoidExecutableApiRequest

Invokes the HTTP client to send the request to the Zulip REST API.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException