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

Class RevokeEmailInvitationApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.invitation.request.RevokeEmailInvitationApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class RevokeEmailInvitationApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for revoking an email invitation.

See Also:

• https://zulip.com/api/revoke-email-invite

Constructor Summary

Constructors

Constructor	Description
RevokeEmailInvitationApiRequest(ZulipHttpClient client, long invitationId)	Constructs a RevokeEmailInvitationApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for revoking an email invitation.

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

RevokeEmailInvitationApiRequest

public RevokeEmailInvitationApiRequest(ZulipHttpClient client,
 long invitationId)

Constructs a RevokeEmailInvitationApiRequest.

Parameters:

client - The Zulip HTTP client

invitationId - The id of the invitation to revoke

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for revoking an email invitation.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful