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

Class GetSavedSnippetsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<SavedSnippet>>

public class GetSavedSnippetsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<SavedSnippet>>

Zulip API request builder for getting all saved snippets.

See Also:

• https://zulip.com/api/get-saved-snippets

Constructor Summary

Constructors

Constructor	Description
GetSavedSnippetsApiRequest(ZulipHttpClient client)	Constructs a GetSavedSnippetsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<SavedSnippet>	execute()	Executes the Zulip API request for getting all saved snippets.

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

GetSavedSnippetsApiRequest

public GetSavedSnippetsApiRequest(ZulipHttpClient client)

Constructs a GetSavedSnippetsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<SavedSnippet> execute()
                           throws ZulipClientException

Executes the Zulip API request for getting all saved snippets.

Specified by:

execute in interface ExecutableApiRequest<List<SavedSnippet>>

Returns:

Throws:

ZulipClientException - if the request was not successful