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

Class GetDataExportConsentStateApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<DataExportConsent>>

public class GetDataExportConsentStateApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<DataExportConsent>>

Zulip API request builder for getting users that have consented to their private data being exported.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
GetDataExportConsentStateApiRequest(ZulipHttpClient client)	Constructs a GetDataExportConsentStateApiRequest.

Method Summary

Modifier and Type	Method	Description
List<DataExportConsent>	execute()	Executes the Zulip API request for getting users that have consented to their private data being exported.

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

client, 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

GetDataExportConsentStateApiRequest

public GetDataExportConsentStateApiRequest(ZulipHttpClient client)

Constructs a GetDataExportConsentStateApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<DataExportConsent> execute()
                                throws ZulipClientException

Executes the Zulip API request for getting users that have consented to their private data being exported.

Specified by:

execute in interface ExecutableApiRequest<List<DataExportConsent>>

Returns:

The response for type T

Throws:

ZulipClientException - if the request was not successful