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

Class GetRealmDomainsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<RealmDomain>>

public class GetRealmDomainsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<RealmDomain>>

Zulip API request builder for getting the allowed email domains configured in the organization.

See Also:

• https://zulip.com/api/get-realm-domains

Constructor Summary

Constructors

Constructor	Description
GetRealmDomainsApiRequest(ZulipHttpClient client)	Constructs a GetRealmDomainsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<RealmDomain>	execute()	Executes the Zulip API request for getting realm allowed domains.

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

GetRealmDomainsApiRequest

public GetRealmDomainsApiRequest(ZulipHttpClient client)

Constructs a GetRealmDomainsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<RealmDomain> execute()
                          throws ZulipClientException

Executes the Zulip API request for getting realm allowed domains.

Specified by:

execute in interface ExecutableApiRequest<List<RealmDomain>>

Returns:

List of RealmDomain objects

Throws:

ZulipClientException - if the request was not successful