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

Class UpdateRealmDomainApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.server.request.UpdateRealmDomainApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateRealmDomainApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for updating whether subdomains are allowed for a realm domain.

See Also:

• https://zulip.com/api/patch-realm-domain

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_SUBDOMAINS

Constructor Summary

Constructors

Constructor	Description
UpdateRealmDomainApiRequest(ZulipHttpClient client, String domain, boolean allowSubdomains)	Constructs an UpdateRealmDomainApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating a realm domain.

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

Field Details

ALLOW_SUBDOMAINS

public static final String ALLOW_SUBDOMAINS

See Also:

• Constant Field Values

Constructor Details

UpdateRealmDomainApiRequest

public UpdateRealmDomainApiRequest(ZulipHttpClient client,
 String domain,
 boolean allowSubdomains)

Constructs an UpdateRealmDomainApiRequest.

Parameters:

client - The Zulip HTTP client

domain - The domain to update

allowSubdomains - Whether subdomains are allowed for this domain

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating a realm domain.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful