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

Class RemoveUsersFromGroupApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class RemoveUsersFromGroupApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for removing users from a group.

See Also:

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
RemoveUsersFromGroupApiRequest(ZulipHttpClient client, long groupId, long... userIds)	Constructs a RemoveUsersFromGroupApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for removing users to a group.
RemoveUsersFromGroupApiRequest	withDeleteSubGroups(long... userGroupIds)	Sets 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

DELETE

public static final String DELETE

See Also:

• Constant Field Values

DELETE_SUBGROUPS

public static final String DELETE_SUBGROUPS

See Also:

• Constant Field Values

Constructor Details

RemoveUsersFromGroupApiRequest

public RemoveUsersFromGroupApiRequest(ZulipHttpClient client,
 long groupId,
 long... userIds)

Constructs a RemoveUsersFromGroupApiRequest.

Parameters:

client - The Zulip HTTP client

groupId - The id of the group to remove users from

userIds - Array of user ids to remove from the group

Method Details

withDeleteSubGroups

public RemoveUsersFromGroupApiRequest withDeleteSubGroups(long... userGroupIds)

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

Parameters:

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

Returns:

This RemoveUsersFromGroupApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for removing users to a group.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful