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

Class UpdateNavigationViewApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateNavigationViewApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for updating a navigation view.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IS_PINNED
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
UpdateNavigationViewApiRequest(ZulipHttpClient client, String fragment)	Constructs a ZulipApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating a navigation view.
UpdateNavigationViewApiRequest	withIsPinned(boolean isPinned)	Sets Whether the view appears directly in the sidebar or is hidden.
UpdateNavigationViewApiRequest	withName(String name)	Sets the name for the navigation view.

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

IS_PINNED

public static final String IS_PINNED

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

UpdateNavigationViewApiRequest

public UpdateNavigationViewApiRequest(ZulipHttpClient client,
 String fragment)

Constructs a ZulipApiRequest.

Parameters:

client - The Zulip HTTP client

fragment - A unique identifier for the navigation view

Method Details

withIsPinned

public UpdateNavigationViewApiRequest withIsPinned(boolean isPinned)

Sets Whether the view appears directly in the sidebar or is hidden.

Parameters:

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

Returns:

This AddNavigationViewApiRequest instance

See Also:

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

withName

public UpdateNavigationViewApiRequest withName(String name)

Sets the name for the navigation view.

Parameters:

name - The name of the navigation view

Returns:

This AddNavigationViewApiRequest instance

See Also:

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

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating a navigation view.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful