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

Class DeactivateUserApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class DeactivateUserApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deactivating a user.

See Also:

• https://zulip.com/api/deactivate-user

Constructor Summary

Constructors

Constructor	Description
DeactivateUserApiRequest(ZulipHttpClient client, long userId)	Constructs a DeactivateUserApiRequest.

Method Summary

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

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

DeactivateUserApiRequest

public DeactivateUserApiRequest(ZulipHttpClient client,
 long userId)

Constructs a DeactivateUserApiRequest.

Parameters:

client - The Zulip HTTP client

userId - The id of the user to deactivate

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for deactivating a user.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful