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

Class DeleteUserAttachmentApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.DeleteUserAttachmentApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class DeleteUserAttachmentApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deleting an attachment.

See Also:

• https://zulip.com/api/remove-attachment

Constructor Summary

Constructors

Constructor	Description
DeleteUserAttachmentApiRequest(ZulipHttpClient client, long attachmentId)	Constructs a DeleteUserAttachmentApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for deleting an attachment.

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

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DeleteUserAttachmentApiRequest

public DeleteUserAttachmentApiRequest(ZulipHttpClient client,
 long attachmentId)

Constructs a DeleteUserAttachmentApiRequest.

Parameters:

client - The Zulip HTTP client

attachmentId - The id of the attachment to delete

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for deleting an attachment.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful