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

Class DeleteSavedSnippetApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.snippet.request.DeleteSavedSnippetApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class DeleteSavedSnippetApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deleting a saved snippet.

See Also:

• https://zulip.com/api/delete-saved-snippet

Constructor Summary

Constructors

Constructor	Description
DeleteSavedSnippetApiRequest(ZulipHttpClient client, int snippetId)	Constructs a DeleteSavedSnippetApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for deleting a saved snippet.

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

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

DeleteSavedSnippetApiRequest

public DeleteSavedSnippetApiRequest(ZulipHttpClient client,
 int snippetId)

Constructs a DeleteSavedSnippetApiRequest.

Parameters:

client - The Zulip HTTP client

snippetId - The ID of the saved snippet to delete

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for deleting a saved snippet.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful