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

Class GetAllNavigationViewsApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.navigationview.request.GetAllNavigationViewsApiRequest

All Implemented Interfaces:

ExecutableApiRequest<List<NavigationView>>

public class GetAllNavigationViewsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<NavigationView>>

Zulip API request builder for getting all navigation views.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
GetAllNavigationViewsApiRequest(ZulipHttpClient client)	Constructs a GetAllNavigationViewsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<NavigationView>	execute()	Executes the Zulip API request for getting all navigation views.

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

Constructor Details

GetAllNavigationViewsApiRequest

public GetAllNavigationViewsApiRequest(ZulipHttpClient client)

Constructs a GetAllNavigationViewsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<NavigationView> execute()
                             throws ZulipClientException

Executes the Zulip API request for getting all navigation views.

Specified by:

execute in interface ExecutableApiRequest<List<NavigationView>>

Returns:

List of NavigationView

Throws:

ZulipClientException - if the request was not successful