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

Class DeleteUserGroupApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class DeleteUserGroupApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deleting a user group.

See Also:

• https://zulip.com/api/remove-user-group

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for deleting a user group.

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

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

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

Constructor Details

DeleteUserGroupApiRequest

public DeleteUserGroupApiRequest(ZulipHttpClient client,
 long groupId)

Constructs a DeleteUserGroupApiRequest.

Parameters:

client - The Zulip HTTP client

groupId - The id of the group to delete

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for deleting a user group.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful