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

Class AddRealmDomainApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class AddRealmDomainApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for adding an allowed domain to the organization.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_SUBDOMAINS
static final String	DOMAIN

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for adding a realm allowed 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

DOMAIN

public static final String DOMAIN

See Also:

• Constant Field Values

ALLOW_SUBDOMAINS

public static final String ALLOW_SUBDOMAINS

See Also:

• Constant Field Values

Constructor Details

AddRealmDomainApiRequest

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

Constructs an AddRealmDomainApiRequest.

Parameters:

client - The Zulip HTTP client

domain - The domain to add

allowSubdomains - Whether subdomains are allowed for this domain

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for adding a realm allowed domain.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful