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

Class DeleteMessageApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class DeleteMessageApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deleting a message.

See Also:

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for deleting a 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

Constructor Details

DeleteMessageApiRequest

public DeleteMessageApiRequest(ZulipHttpClient client,
 long messageId)

Constructs a DeleteMessageApiRequest.

Parameters:

client - The Zulip HTTP client

messageId - The id of the message to delete

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for deleting a message.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful