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

Class SendScheduledMessageApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Long>

public class SendScheduledMessageApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Long>

Zulip API request builder for sending a scheduled message.

See Also:

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
SendScheduledMessageApiRequest(ZulipHttpClient client, MessageType type, String content, Instant deliveryTimestamp, long... to)	Constructs a SendScheduledMessageApiRequest for sending a scheduled message.

Method Summary

Modifier and Type	Method	Description
Long	execute()	Executes the Zulip API request for sending a scheduled message.
SendScheduledMessageApiRequest	withReadBySender(boolean readBySender)	Sets optional the value of whether the message should be initially marked read by its sender.
SendScheduledMessageApiRequest	withTopic(String topic)	Sets the topic of the message.

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

READ_BY_SENDER

public static final String READ_BY_SENDER

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

SendScheduledMessageApiRequest

public SendScheduledMessageApiRequest(ZulipHttpClient client,
 MessageType type,
 String content,
 Instant deliveryTimestamp,
 long... to)

Constructs a SendScheduledMessageApiRequest for sending a scheduled message.

Parameters:

client - The Zulip HTTP client

type - The type of scheduled message to be sent

content - The content of the message

deliveryTimestamp - The UNIX epoch timestamp for when the message will be sent

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

Method Details

withReadBySender

public SendScheduledMessageApiRequest withReadBySender(boolean readBySender)

Sets optional the value of whether the message should be initially marked read by its sender.

Parameters:

readBySender - Whether the message should be initially marked read by its sender

Returns:

This SendScheduledMessageApiRequest instance

See Also:

• https://zulip.com/api/create-scheduled-message#parameter-read_by_sender

withTopic

public SendScheduledMessageApiRequest 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 SendScheduledMessageApiRequest instance

See Also:

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

execute

public Long execute()
             throws ZulipClientException

Executes the Zulip API request for sending a scheduled message.

Specified by:

execute in interface ExecutableApiRequest<Long>

Returns:

The id of the scheduled message

Throws:

ZulipClientException - if the request was not successful