Class DeactivateRealmApiRequest
java.lang.Object
com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest
com.github.jamesnetherton.zulip.client.api.server.request.DeactivateRealmApiRequest
- All Implemented Interfaces:
VoidExecutableApiRequest
Zulip API request builder for deactivating the organization.
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidexecute()Executes the Zulip API request for deactivating the organization.withDeletionDelayDays(Integer deletionDelayDays) Sets the number of days to wait before permanently deleting the deactivated organization's data.Methods inherited from class ZulipApiRequest
client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject
-
Field Details
-
DELETION_DELAY_DAYS
- See Also:
-
-
Constructor Details
-
DeactivateRealmApiRequest
Constructs aDeactivateRealmApiRequest.- Parameters:
client- The Zulip HTTP client
-
-
Method Details
-
withDeletionDelayDays
Sets the number of days to wait before permanently deleting the deactivated organization's data. The permitted range is determined by the server.- Parameters:
deletionDelayDays- The number of days before the data is deleted.0deletes it immediately, meaning the organization cannot be reactivated.nullretains the data indefinitely- Returns:
- This
DeactivateRealmApiRequestinstance - See Also:
-
execute
Executes the Zulip API request for deactivating the organization.- Specified by:
executein interfaceVoidExecutableApiRequest- Throws:
ZulipClientException- if the request was not successful
-