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

Class GetServerSettingsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<ServerSettings>

public class GetServerSettingsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<ServerSettings>

Zulip API request builder for getting server settings.

See Also:

• https://zulip.com/api/get-server-settings

Constructor Summary

Constructors

Constructor	Description
GetServerSettingsApiRequest(ZulipHttpClient client)	Constructs a GetServerSettingsApiRequest.

Method Summary

Modifier and Type	Method	Description
ServerSettings	execute()	Executes the Zulip API request for getting server settings.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GetServerSettingsApiRequest

public GetServerSettingsApiRequest(ZulipHttpClient client)

Constructs a GetServerSettingsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public ServerSettings execute()
                       throws ZulipClientException

Executes the Zulip API request for getting server settings.

Specified by:

execute in interface ExecutableApiRequest<ServerSettings>

Returns:

A ServerSettings

Throws:

ZulipClientException - if the request was not successful