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

Class GetUserGroupsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<UserGroup>>

public class GetUserGroupsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<UserGroup>>

Zulip API request builder for getting all user groups.

See Also:

• https://zulip.com/api/get-user-groups

Constructor Summary

Constructors

Constructor	Description
GetUserGroupsApiRequest(ZulipHttpClient client)	Constructs a GetUserGroupsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<UserGroup>	execute()	Executes the Zulip API request for getting all user groups.

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

client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GetUserGroupsApiRequest

public GetUserGroupsApiRequest(ZulipHttpClient client)

Constructs a GetUserGroupsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<UserGroup> execute()
                        throws ZulipClientException

Executes the Zulip API request for getting all user groups.

Specified by:

execute in interface ExecutableApiRequest<List<UserGroup>>

Returns:

List of UserGroup objects

Throws:

ZulipClientException - if the request was not successful