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

Class CreateUserGroupApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.CreateUserGroupApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class CreateUserGroupApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for creating a user to a group.

See Also:

• https://zulip.com/api/create-user-group

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAN_MENTION_GROUP
static final String	DESCRIPTION
static final String	MEMBERS
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
CreateUserGroupApiRequest(ZulipHttpClient client, String name, String description, long... userIds)	Constructs a CreateUserGroupApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for adding creating a user group.
CreateUserGroupApiRequest	withCanMentionGroup(long groupId)	Sets the optional ID of the user group whose members are allowed to mention the new user group.

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

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

MEMBERS

public static final String MEMBERS

See Also:

• Constant Field Values

CAN_MENTION_GROUP

public static final String CAN_MENTION_GROUP

See Also:

• Constant Field Values

Constructor Details

CreateUserGroupApiRequest

public CreateUserGroupApiRequest(ZulipHttpClient client,
 String name,
 String description,
 long... userIds)

Constructs a CreateUserGroupApiRequest.

Parameters:

client - The Zulip HTTP client

name - The name of the user group

description - The user group description

userIds - Array of user ids to add to the group

Method Details

withCanMentionGroup

public CreateUserGroupApiRequest withCanMentionGroup(long groupId)

Sets the optional ID of the user group whose members are allowed to mention the new user group.

Parameters:

groupId - The ID of the user group whose members are allowed to mention the new user group

Returns:

This CreateUserGroupApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for adding creating a user group.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful