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:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionUpdateNavigationViewApiRequest(ZulipHttpClient client, String fragment) Constructs aZulipApiRequest. -
Method Summary
Modifier and TypeMethodDescriptionvoidexecute()Executes the Zulip API request for updating a navigation view.withIsPinned(boolean isPinned) Sets Whether the view appears directly in the sidebar or is hidden.Sets the name for the navigation view.Methods inherited from class ZulipApiRequest
client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject
-
Field Details
-
IS_PINNED
- See Also:
-
NAME
- See Also:
-
-
Constructor Details
-
UpdateNavigationViewApiRequest
Constructs aZulipApiRequest.- Parameters:
client- The Zulip HTTP clientfragment- A unique identifier for the navigation view
-
-
Method Details
-
withIsPinned
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
AddNavigationViewApiRequestinstance - See Also:
-
withName
Sets the name for the navigation view.- Parameters:
name- The name of the navigation view- Returns:
- This
AddNavigationViewApiRequestinstance - See Also:
-
execute
Executes the Zulip API request for updating a navigation view.- Specified by:
executein interfaceVoidExecutableApiRequest- Throws:
ZulipClientException- if the request was not successful
-