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

Class EditSavedSnippetApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class EditSavedSnippetApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for editing a saved snippet.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT
static final String	TITLE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for editing a saved snippet.
EditSavedSnippetApiRequest	withContent(String content)	Sets the optional saved snippet content to edit.
EditSavedSnippetApiRequest	withTitle(String title)	Sets the optional saved snippet title to edit.

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

Field Details

CONTENT

public static final String CONTENT

See Also:

• Constant Field Values

TITLE

public static final String TITLE

See Also:

• Constant Field Values

Constructor Details

EditSavedSnippetApiRequest

public EditSavedSnippetApiRequest(ZulipHttpClient client,
 int snippetId)

Constructs a EditSavedSnippetApiRequest.

Parameters:

client - The Zulip HTTP client

snippetId - The ID of the saved snippet to edit

Method Details

withContent

public EditSavedSnippetApiRequest withContent(String content)

Sets the optional saved snippet content to edit.

Parameters:

content - The new saved snippet content

Returns:

This EditSavedSnippetApiRequest instance

withTitle

public EditSavedSnippetApiRequest withTitle(String title)

Sets the optional saved snippet title to edit.

Parameters:

title - The new saved snippet title

Returns:

This EditSavedSnippetApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for editing a saved snippet.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful