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

Class CreateSavedSnippetApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Integer>

public class CreateSavedSnippetApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Integer>

Zulip API request builder for creating a saved snippet.

See Also:

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
CreateSavedSnippetApiRequest(ZulipHttpClient client, String title, String content)	Constructs a CreateSavedSnippetApiRequest.

Method Summary

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

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

CreateSavedSnippetApiRequest

public CreateSavedSnippetApiRequest(ZulipHttpClient client,
 String title,
 String content)

Constructs a CreateSavedSnippetApiRequest.

Parameters:

client - The Zulip HTTP client

title - The title of the saved snippet

content - The content of the saved snippet in text or Markdown format

Method Details

execute

public Integer execute()
                throws ZulipClientException

Executes the Zulip API request for creating a saved snippet.

Specified by:

execute in interface ExecutableApiRequest<Integer>

Returns:

The id of the created saved snippet

Throws:

ZulipClientException - if the request was not successful