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

Class UpdateUserGroupSubGroupsApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.UpdateUserGroupSubGroupsApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateUserGroupSubGroupsApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for updating user group sub groups.

See Also:

• https://zulip.com/api/update-user-group-subgroups

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD
static final String	DELETE

Constructor Summary

Constructors

Constructor	Description
UpdateUserGroupSubGroupsApiRequest(ZulipHttpClient client, long userGroupId)	Constructs a UpdateUserGroupSubGroupsApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating user group sub groups.
UpdateUserGroupSubGroupsApiRequest	withAddUserGroups(List<Long> userGroupIds)	The list of user group IDs to be added to the user group.
UpdateUserGroupSubGroupsApiRequest	withDeleteUserGroups(List<Long> userGroupIds)	The list of user group IDs to be removed from the user group.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, 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

ADD

public static final String ADD

See Also:

• Constant Field Values

DELETE

public static final String DELETE

See Also:

• Constant Field Values

Constructor Details

UpdateUserGroupSubGroupsApiRequest

public UpdateUserGroupSubGroupsApiRequest(ZulipHttpClient client,
 long userGroupId)

Constructs a UpdateUserGroupSubGroupsApiRequest.

Parameters:

client - The Zulip HTTP client

userGroupId - The ID of the user group to update

Method Details

withAddUserGroups

public UpdateUserGroupSubGroupsApiRequest withAddUserGroups(List<Long> userGroupIds)

The list of user group IDs to be added to the user group.

Parameters:

userGroupIds - The list of user group IDs to be added to the user group

Returns:

This UpdateUserGroupSubGroupsApiRequest instance

withDeleteUserGroups

public UpdateUserGroupSubGroupsApiRequest withDeleteUserGroups(List<Long> userGroupIds)

The list of user group IDs to be removed from the user group.

Parameters:

userGroupIds - The list of user group IDs to be removed from the user group

Returns:

This UpdateUserGroupSubGroupsApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating user group sub groups.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful