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

Class SnippetService

java.lang.Object

com.github.jamesnetherton.zulip.client.api.snippet.SnippetService

All Implemented Interfaces:

ZulipService

public class SnippetService
extends Object
implements ZulipService

Zulip saved snippet APIs.

Constructor Summary

Constructors

Constructor	Description
SnippetService(ZulipHttpClient client)	Constructs a SnippetService

Method Summary

Modifier and Type	Method	Description
CreateSavedSnippetApiRequest	createSavedSnippet(String title, String content)	Creates a new saved snippet.
DeleteSavedSnippetApiRequest	deleteSavedSnippet(int snippetId)	Deletes a saved snippet.
EditSavedSnippetApiRequest	editSavedSnippet(int snippetId)	Edits a saved snippet.
GetSavedSnippetsApiRequest	getSavedSnippets()	Gets all saved snippets.

Methods inherited from class java.lang.Object

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

Constructor Details

SnippetService

public SnippetService(ZulipHttpClient client)

Constructs a SnippetService

Parameters:

client - The Zulip HTTP client

Method Details

createSavedSnippet

public CreateSavedSnippetApiRequest createSavedSnippet(String title,
 String content)

Creates a new saved snippet.

Parameters:

title - The title of the saved snippet

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

Returns:

The CreateSavedSnippetApiRequest builder object

See Also:

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

deleteSavedSnippet

public DeleteSavedSnippetApiRequest deleteSavedSnippet(int snippetId)

Deletes a saved snippet.

Returns:

The DeleteSavedSnippetApiRequest builder object

See Also:

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

editSavedSnippet

public EditSavedSnippetApiRequest editSavedSnippet(int snippetId)

Edits a saved snippet.

Returns:

The EditSavedSnippetApiRequest builder object

See Also:

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

getSavedSnippets

public GetSavedSnippetsApiRequest getSavedSnippets()

Gets all saved snippets.

Returns:

The GetSavedSnippetsApiRequest builder object

See Also:

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