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

Class CreateReusableInvitationLinkApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<String>

public class CreateReusableInvitationLinkApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<String>

Zulip API request builder for creating a reusable invitation link.

See Also:

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

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	STREAM_IDS

Constructor Summary

Constructors

Constructor	Description
CreateReusableInvitationLinkApiRequest(ZulipHttpClient client)	Constructs a CreateReusableInvitationLinkApiRequest.

Method Summary

Modifier and Type	Method	Description
String	execute()	Executes the Zulip API request for creating a reusable invitation link.
CreateReusableInvitationLinkApiRequest	inviteExpiresInMinutes(int minutes)	Sets the number of minutes before the invitation will expire.
CreateReusableInvitationLinkApiRequest	streamIds(long... streamIds)	Sets the list of channel ids that the newly created user will be automatically subscribed to.
CreateReusableInvitationLinkApiRequest	withGroupIds(long... groupIds)	Sets the ids of groups that the user should be added to upon accepting the invitation.
CreateReusableInvitationLinkApiRequest	withIncludeRealmDefaultSubscriptions(boolean includeRealmDefaultSubscriptions)	Sets whether the newly created user should be subscribed to the default channels for the organization.
CreateReusableInvitationLinkApiRequest	withInviteAs(UserRole role)	Sets the organization level role of the user that is created when the invitation is accepted.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, 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

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

STREAM_IDS

public static final String STREAM_IDS

See Also:

• Constant Field Values

Constructor Details

CreateReusableInvitationLinkApiRequest

public CreateReusableInvitationLinkApiRequest(ZulipHttpClient client)

Constructs a CreateReusableInvitationLinkApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withGroupIds

public CreateReusableInvitationLinkApiRequest 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 CreateReusableInvitationLinkApiRequest instance

See Also:

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

withIncludeRealmDefaultSubscriptions

public CreateReusableInvitationLinkApiRequest 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 CreateReusableInvitationLinkApiRequest instance

See Also:

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

withInviteAs

public CreateReusableInvitationLinkApiRequest 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 CreateReusableInvitationLinkApiRequest instance

See Also:

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

inviteExpiresInMinutes

public CreateReusableInvitationLinkApiRequest 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 CreateReusableInvitationLinkApiRequest instance

See Also:

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

streamIds

public CreateReusableInvitationLinkApiRequest streamIds(long... streamIds)

Sets the list of channel ids that the newly created user will be automatically subscribed to.

Parameters:

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

Returns:

This CreateReusableInvitationLinkApiRequest instance

See Also:

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

execute

public String execute()
               throws ZulipClientException

Executes the Zulip API request for creating a reusable invitation link.

Specified by:

execute in interface ExecutableApiRequest<String>

Returns:

The generated invitation link URL

Throws:

ZulipClientException - if the request was not successful