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

Class SendInvitationsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class SendInvitationsApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for sending user invitations.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GROUP_IDS
static final String	INCLUDE_REALM_DEFAULT_SUBSCRIPTIONS
static final String	INVITE_AS
static final String	INVITE_EXPIRES_IN_MINUTES
static final String	INVITEE_EMAILS
static final String	NOTIFIY_REFERRER_ON_JOIN
static final String	STREAM_IDS
static final String	WELCOME_MESSAGE_CUSTOM_TEXT

Constructor Summary

Constructors

Constructor	Description
SendInvitationsApiRequest(ZulipHttpClient client, List<String> inviteeEmails, List<Long> streamIds)	Constructs a SendInvitationsApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for sending user invitations.
SendInvitationsApiRequest	inviteExpiresInMinutes(int minutes)	Sets the number of minutes before the invitation will expire.
SendInvitationsApiRequest	withGroupIds(long... groupIds)	Sets the ids of groups that the user should be added to upon accepting the invitation.
SendInvitationsApiRequest	withIncludeRealmDefaultSubscriptions(boolean includeRealmDefaultSubscriptions)	Sets whether the newly created user should be subscribed to the default channels for the organization.
SendInvitationsApiRequest	withInviteAs(UserRole role)	Sets the organization level role of the user that is created when the invitation is accepted.
SendInvitationsApiRequest	withNotifyReferrerOnJoin(boolean notifyReferrerOnJoin)	Sets whether the referrer would like to receive a direct message from notification bot when a user account is created.
SendInvitationsApiRequest	withWelcomeMessageCustomText(String welcomeMessageCustomText)	Sets a custom message to be sent by the Welcome Bot to new users that join the organization via this 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

Field Details

GROUP_IDS

public static final String GROUP_IDS

See Also:

• Constant Field Values

INCLUDE_REALM_DEFAULT_SUBSCRIPTIONS

public static final String INCLUDE_REALM_DEFAULT_SUBSCRIPTIONS

See Also:

• Constant Field Values

INVITEE_EMAILS

public static final String INVITEE_EMAILS

See Also:

• Constant Field Values

INVITE_AS

public static final String INVITE_AS

See Also:

• Constant Field Values

INVITE_EXPIRES_IN_MINUTES

public static final String INVITE_EXPIRES_IN_MINUTES

See Also:

• Constant Field Values

NOTIFIY_REFERRER_ON_JOIN

public static final String NOTIFIY_REFERRER_ON_JOIN

See Also:

• Constant Field Values

STREAM_IDS

public static final String STREAM_IDS

See Also:

• Constant Field Values

WELCOME_MESSAGE_CUSTOM_TEXT

public static final String WELCOME_MESSAGE_CUSTOM_TEXT

See Also:

• Constant Field Values

Constructor Details

SendInvitationsApiRequest

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

Constructs a SendInvitationsApiRequest.

Parameters:

client - The Zulip HTTP client

inviteeEmails - The list of email addresses to invite

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

Method Details

withGroupIds

public SendInvitationsApiRequest withGroupIds(long... groupIds)

Sets the ids of groups that the user should be added to upon accepting the invitation.

Parameters:

groupIds - The ids of the invited user should be added to

Returns:

This SendInvitationsApiRequest instance

withIncludeRealmDefaultSubscriptions

public SendInvitationsApiRequest withIncludeRealmDefaultSubscriptions(boolean includeRealmDefaultSubscriptions)

Sets whether the newly created user should be subscribed to the default channels for the organization.

Parameters:

includeRealmDefaultSubscriptions - When true, the newly created user will be subscribed to the default channels for the organization. When false the user is not subscribed to any default channels.

Returns:

This SendInvitationsApiRequest instance

See Also:

• https://zulip.com/api/send-invites#parameter-include_realm_default_subscriptions

withInviteAs

public SendInvitationsApiRequest withInviteAs(UserRole role)

Sets the organization level role of the user that is created when the invitation is accepted.

Parameters:

role - The UserRole that should apply to the new user

Returns:

This SendInvitationsApiRequest instance

See Also:

• https://zulip.com/api/send-invites#parameter-invite_as

inviteExpiresInMinutes

public SendInvitationsApiRequest inviteExpiresInMinutes(int minutes)

Sets the number of minutes before the invitation will expire.

Parameters:

minutes - The number of minutes before the invitation will expire

Returns:

This SendInvitationsApiRequest instance

See Also:

• https://zulip.com/api/send-invites#parameter-invite_expires_in_minutes

withNotifyReferrerOnJoin

public SendInvitationsApiRequest withNotifyReferrerOnJoin(boolean notifyReferrerOnJoin)

Sets whether the referrer would like to receive a direct message from notification bot when a user account is created.

Parameters:

notifyReferrerOnJoin - When true the referrer will receive a direct message from notification bot when a user account is created. When false no notification is sent

Returns:

This SendInvitationsApiRequest instance

See Also:

• https://zulip.com/api/send-invites#parameter-notify_referrer_on_join

withWelcomeMessageCustomText

public SendInvitationsApiRequest withWelcomeMessageCustomText(String welcomeMessageCustomText)

Sets a custom message to be sent by the Welcome Bot to new users that join the organization via this invitation.

Parameters:

welcomeMessageCustomText - The welcome message content

Returns:

This SendInvitationsApiRequest instance

See Also:

• https://zulip.com/api/send-invites#parameter-welcome_message_custom_text

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for sending user invitations.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful