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

Class EditMessageApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<DetachedUpload>>

public class EditMessageApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<DetachedUpload>>

Zulip API request builder for editing a message.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT
static final String	PROPAGATE_MODE
static final String	SEND_NOTIFICATION_TO_NEW_THREAD
static final String	SEND_NOTIFICATION_TO_OLD_THREAD
static final String	STREAM_ID
static final String	TOPIC

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<DetachedUpload>	execute()	Executes the Zulip API request for editing a message.
EditMessageApiRequest	withContent(String content)	Sets the optional edited message content.
EditMessageApiRequest	withPropagateMode(PropagateMode mode)	Sets the optional propagation mode.
EditMessageApiRequest	withSendNotificationToNewThread(boolean send)	Sets the optional flag for whether to send a message to the new thread to notify users where the message came from.
EditMessageApiRequest	withSendNotificationToOldThread(boolean send)	Sets the optional flag for whether to send a message to the old thread to notify users where the message has moved to.
EditMessageApiRequest	withStreamId(long streamId)	Sets the optional id of the stream to move the message to.
EditMessageApiRequest	withTopic(String topic)	Sets the optional name of the topic to move the message to.

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

PROPAGATE_MODE

public static final String PROPAGATE_MODE

See Also:

• Constant Field Values

SEND_NOTIFICATION_TO_OLD_THREAD

public static final String SEND_NOTIFICATION_TO_OLD_THREAD

See Also:

• Constant Field Values

SEND_NOTIFICATION_TO_NEW_THREAD

public static final String SEND_NOTIFICATION_TO_NEW_THREAD

See Also:

• Constant Field Values

STREAM_ID

public static final String STREAM_ID

See Also:

• Constant Field Values

TOPIC

public static final String TOPIC

See Also:

• Constant Field Values

Constructor Details

EditMessageApiRequest

public EditMessageApiRequest(ZulipHttpClient client,
 long messageId)

Constructs a EditMessageApiRequest.

Parameters:

client - The Zulip HTTP client

messageId - The id of the message to edit

Method Details

withContent

public EditMessageApiRequest withContent(String content)

Sets the optional edited message content.

Parameters:

content - The modified message content

Returns:

This EditMessageApiRequest instance

See Also:

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

withPropagateMode

public EditMessageApiRequest withPropagateMode(PropagateMode mode)

Sets the optional propagation mode. Controls which messages(s) should be deleted.

Parameters:

mode - The propagation mode to use

Returns:

This EditMessageApiRequest instance

See Also:

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

withSendNotificationToOldThread

public EditMessageApiRequest withSendNotificationToOldThread(boolean send)

Sets the optional flag for whether to send a message to the old thread to notify users where the message has moved to.

Parameters:

send - true to send message notifications to the old thread. false to not send any notification

Returns:

This EditMessageApiRequest instance

See Also:

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

withSendNotificationToNewThread

public EditMessageApiRequest withSendNotificationToNewThread(boolean send)

Sets the optional flag for whether to send a message to the new thread to notify users where the message came from.

Parameters:

send - true to send message notifications to the new thread. false to not send any notification

Returns:

This EditMessageApiRequest instance

See Also:

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

withStreamId

public EditMessageApiRequest withStreamId(long streamId)

Sets the optional id of the stream to move the message to.

Parameters:

streamId - The id of the stream to which the message should be moved to

Returns:

This EditMessageApiRequest instance

See Also:

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

withTopic

public EditMessageApiRequest withTopic(String topic)

Sets the optional name of the topic to move the message to.

Parameters:

topic - The name of the topic that the message should use

Returns:

This EditMessageApiRequest instance

See Also:

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

execute

public List<DetachedUpload> execute()
                             throws ZulipClientException

Executes the Zulip API request for editing a message.

Specified by:

execute in interface ExecutableApiRequest<List<DetachedUpload>>

Returns:

The response for type T

Throws:

ZulipClientException - if the request was not successful