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

Class DeleteEventQueueApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.event.request.DeleteEventQueueApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class DeleteEventQueueApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for deleting a event queue.

See Also:

• https://zulip.com/api/delete-queue

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QUEUE_ID

Constructor Summary

Constructors

Constructor	Description
DeleteEventQueueApiRequest(ZulipHttpClient client, String queueId)	Constructs a ZulipApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for deleting a event queue.

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

QUEUE_ID

public static final String QUEUE_ID

See Also:

• Constant Field Values

Constructor Details

DeleteEventQueueApiRequest

public DeleteEventQueueApiRequest(ZulipHttpClient client,
 String queueId)

Constructs a ZulipApiRequest.

Parameters:

client - The Zulip HTTP client

queueId - the queue id to delete

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for deleting a event queue.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful