Class GetUserGroupMembersApiRequest
java.lang.Object
com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest
com.github.jamesnetherton.zulip.client.api.user.request.GetUserGroupMembersApiRequest
- All Implemented Interfaces:
ExecutableApiRequest<List<Long>>
public class GetUserGroupMembersApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<Long>>
Zulip API request builder for getting the members of a user group.
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionGetUserGroupMembersApiRequest(ZulipHttpClient client, long userGroupId) Constructs aGetUserGroupMembersApiRequest. -
Method Summary
Modifier and TypeMethodDescriptionexecute()Executes the Zulip API request for getting members of a user group.withDirectMemberOnly(boolean isDirectMemberOnly) Sets Whether to consider only the direct members of user group and not members of its subgroups.Methods inherited from class ZulipApiRequest
client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject
-
Field Details
-
DIRECT_MEMBER_ONLY
- See Also:
-
-
Constructor Details
-
GetUserGroupMembersApiRequest
Constructs aGetUserGroupMembersApiRequest.- Parameters:
client- The Zulip HTTP clientuserGroupId- The id of the user group from which to get members
-
-
Method Details
-
withDirectMemberOnly
Sets Whether to consider only the direct members of user group and not members of its subgroups.- Parameters:
isDirectMemberOnly-trueto consider only direct members of the user group.falseto not consider direct members of the user group- Returns:
- This
GetUserGroupMembersApiRequestinstance
-
execute
Executes the Zulip API request for getting members of a user group.- Specified by:
executein interfaceExecutableApiRequest<List<Long>>- Returns:
- The user IDs for the members of the user group
- Throws:
ZulipClientException- if the request was not successful
-