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

Class GetAllInvitationsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<Invitation>>

public class GetAllInvitationsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<Invitation>>

Zulip API request builder for fetching invitations.

See Also:

• https://zulip.com/api/get-invites

Constructor Summary

Constructors

Constructor	Description
GetAllInvitationsApiRequest(ZulipHttpClient client)	Constructs a GetAllInvitationsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<Invitation>	execute()	Executes the Zulip API request for fetching invitations.

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

GetAllInvitationsApiRequest

public GetAllInvitationsApiRequest(ZulipHttpClient client)

Constructs a GetAllInvitationsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<Invitation> execute()
                         throws ZulipClientException

Executes the Zulip API request for fetching invitations.

Specified by:

execute in interface ExecutableApiRequest<List<Invitation>>

Returns:

List of Invitation containing each unexpired invitation

Throws:

ZulipClientException - if the request was not successful