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

Class InvitationService

java.lang.Object

com.github.jamesnetherton.zulip.client.api.invitation.InvitationService

All Implemented Interfaces:

ZulipService

public class InvitationService
extends Object
implements ZulipService

Zulip invitation APIs.

Constructor Summary

Constructors

Constructor	Description
InvitationService(ZulipHttpClient client)	Constructs a InvitationService.

Method Summary

Modifier and Type	Method	Description
CreateReusableInvitationLinkApiRequest	createReusableInvitationLink()	Creates a new invitation link.
GetAllInvitationsApiRequest	getAllInvitations()	Fetches all unexpired invitations.
ResendEmailInvitationApiRequest	resendEmailInvitation(long invitationId)	Resends an email invitation.
RevokeEmailInvitationApiRequest	revokeEmailInvitation(long invitationId)	Revokes an email invitation.
RevokeReusableInvitationApiRequest	revokeReusableInvitation(long invitationId)	Revokes a reusable invitation.
SendInvitationsApiRequest	sendInvitations(List<String> inviteeEmails, List<Long> streamIds)	Send invitations to specified email addresses.

Methods inherited from class java.lang.Object

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

Constructor Details

InvitationService

public InvitationService(ZulipHttpClient client)

Constructs a InvitationService.

Parameters:

client - The Zulip HTTP client

Method Details

createReusableInvitationLink

public CreateReusableInvitationLinkApiRequest createReusableInvitationLink()

Creates a new invitation link.

Returns:

The CreateReusableInvitationLinkApiRequest builder object

See Also:

• https://zulip.com/api/create-invite-link

getAllInvitations

public GetAllInvitationsApiRequest getAllInvitations()

Fetches all unexpired invitations.

Returns:

The GetAllInvitationsApiRequest builder object

See Also:

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

resendEmailInvitation

public ResendEmailInvitationApiRequest resendEmailInvitation(long invitationId)

Resends an email invitation.

Parameters:

invitationId - The id of the invitation to resend

Returns:

The ResendEmailInvitationApiRequest builder object

See Also:

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

revokeEmailInvitation

public RevokeEmailInvitationApiRequest revokeEmailInvitation(long invitationId)

Revokes an email invitation.

Parameters:

invitationId - The id of the invitation to revoke

Returns:

The RevokeEmailInvitationApiRequest builder object

See Also:

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

revokeReusableInvitation

public RevokeReusableInvitationApiRequest revokeReusableInvitation(long invitationId)

Revokes a reusable invitation.

Parameters:

invitationId - The id of the invitation to revoke

Returns:

The RevokeReusableInvitationApiRequest builder object

See Also:

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

sendInvitations

public SendInvitationsApiRequest sendInvitations(List<String> inviteeEmails,
 List<Long> streamIds)

Send invitations to specified email addresses.

Parameters:

inviteeEmails - The list of email addresses to invite

streamIds - The list of channel ids that the newly created user will be automatically subscribed to

Returns:

The SendInvitationsApiRequest builder object

See Also:

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