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

Class AddUsersToGroupApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class AddUsersToGroupApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for adding users to a group.

See Also:

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for adding users to a group.
AddUsersToGroupApiRequest	withAddSubGroups(long... userGroupIds)	Sets the list of user group IDs to be added to 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

ADD_SUBGROUPS

public static final String ADD_SUBGROUPS

See Also:

• Constant Field Values

Constructor Details

AddUsersToGroupApiRequest

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

Constructs a AddUsersToGroupApiRequest.

Parameters:

client - The Zulip HTTP client

groupId - The id of the group to add users to

userIds - Array of user ids to add to the group

Method Details

withAddSubGroups

public AddUsersToGroupApiRequest withAddSubGroups(long... userGroupIds)

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

Parameters:

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

Returns:

This AddUsersToGroupApiRequest instance

execute

public void execute()
             throws ZulipClientException

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

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful