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

Class NavigationViewService

java.lang.Object

com.github.jamesnetherton.zulip.client.api.navigationview.NavigationViewService

All Implemented Interfaces:

ZulipService

public class NavigationViewService
extends Object
implements ZulipService

Zulip navigation view APIs.

Constructor Summary

Constructors

Constructor	Description
NavigationViewService(ZulipHttpClient client)	Constructs a NavigationViewService.

Method Summary

Modifier and Type	Method	Description
AddNavigationViewApiRequest	addNavigationView(String fragment, boolean isPinned)	Adds a new navigation view.
DeleteNavigationViewApiRequest	deleteNavigationView(String fragment)	Deletes a navigation view.
GetAllNavigationViewsApiRequest	getAllNavigationViews()	Gets all navigation views.
UpdateNavigationViewApiRequest	updateNavigationView(String fragment)	Updates a navigation view.

Methods inherited from class java.lang.Object

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

Constructor Details

NavigationViewService

public NavigationViewService(ZulipHttpClient client)

Constructs a NavigationViewService.

Parameters:

client - The Zulip HTTP client

Method Details

addNavigationView

public AddNavigationViewApiRequest addNavigationView(String fragment,
 boolean isPinned)

Adds a new navigation view.

Parameters:

fragment - A unique identifier for the navigation view

isPinned - Whether the view appears directly in the sidebar or is hidden

Returns:

The AddNavigationViewApiRequest builder object

See Also:

• https://zulip.com/api/add-navigation-view

deleteNavigationView

public DeleteNavigationViewApiRequest deleteNavigationView(String fragment)

Deletes a navigation view.

Parameters:

fragment - The unique identifier of the navigation view to be deleted

Returns:

The DeleteNavigationViewApiRequest builder object

See Also:

• https://zulip.com/api/remove-navigation-view

getAllNavigationViews

public GetAllNavigationViewsApiRequest getAllNavigationViews()

Gets all navigation views.

Returns:

The GetAllNavigationViewsApiRequest builder object

See Also:

• https://zulip.com/api/get-navigation-views

updateNavigationView

public UpdateNavigationViewApiRequest updateNavigationView(String fragment)

Updates a navigation view.

Parameters:

fragment - The unique identifier of the navigation view to update

Returns:

The UpdateNavigationViewApiRequest builder object

See Also:

• https://zulip.com/api/edit-navigation-view