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

Class GetSubGroupsOfUserGroupApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<Long>>

public class GetSubGroupsOfUserGroupApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<Long>>

Get the subgroups of a user group.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DIRECT_SUBGROUP_ONLY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<Long>	execute()	Executes the Zulip API request for updating user group sub groups.
GetSubGroupsOfUserGroupApiRequest	withDirectSubGroupOnly(boolean isDirectSubGroupOnly)	Sets whether to consider only direct subgroups of the user group or subgroups of subgroups.

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

DIRECT_SUBGROUP_ONLY

public static final String DIRECT_SUBGROUP_ONLY

See Also:

• Constant Field Values

Constructor Details

GetSubGroupsOfUserGroupApiRequest

public GetSubGroupsOfUserGroupApiRequest(ZulipHttpClient client,
 long userGroupId)

Constructs a GetSubGroupsOfUserGroupApiRequest.

Parameters:

client - The Zulip HTTP client

userGroupId - The ID of the user group

Method Details

withDirectSubGroupOnly

public GetSubGroupsOfUserGroupApiRequest withDirectSubGroupOnly(boolean isDirectSubGroupOnly)

Sets whether to consider only direct subgroups of the user group or subgroups of subgroups.

Parameters:

isDirectSubGroupOnly - Whether to consider only direct subgroups of the user group or subgroups of subgroups

Returns:

This GetSubGroupsOfUserGroupApiRequest instance

execute

public List<Long> execute()
                   throws ZulipClientException

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

Specified by:

execute in interface ExecutableApiRequest<List<Long>>

Returns:

the list containing the IDs of subgroups for the user group

Throws:

ZulipClientException - if the request was not successful