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

Class UpdateUserGroupApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateUserGroupApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for updating a user group.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAN_ADD_MEMBERS_GROUP
static final String	CAN_JOIN_GROUP
static final String	CAN_LEAVE_GROUP
static final String	CAN_MANAGE_GROUP
static final String	CAN_MENTION_GROUP
static final String	CAN_REMOVE_MEMBERS_GROUP
static final String	DEACTIVATED
static final String	DESCRIPTION
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
UpdateUserGroupApiRequest(ZulipHttpClient client, long groupId)	Constructs a UpdateUserGroupApiRequest.
UpdateUserGroupApiRequest(ZulipHttpClient client, String name, String description, long groupId)	Constructs a UpdateUserGroupApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating a user group.
UpdateUserGroupApiRequest	withCanAddMembersGroup(UserGroupSetting userGroupSetting)	Sets the users who have permission to add members to this group.
UpdateUserGroupApiRequest	withCanJoinMembersGroup(UserGroupSetting userGroupSetting)	Sets the users who have permission to join this group.
UpdateUserGroupApiRequest	withCanLeaveGroup(UserGroupSetting userGroupSetting)	Sets the users who have permission to leave this group.
UpdateUserGroupApiRequest	withCanManageGroup(UserGroupSetting userGroupSetting)	Sets the users who have permission to manage this group.
UpdateUserGroupApiRequest	withCanMentionGroup(long userGroupId)	Deprecated, for removal: This API element is subject to removal in a future version. Use withCanMentionGroup(UserGroupSetting)
UpdateUserGroupApiRequest	withCanMentionGroup(UserGroupSetting userGroupSetting)	Sets the users who have permission to mention this group.
UpdateUserGroupApiRequest	withCanRemoveMembersGroup(UserGroupSetting userGroupSetting)	Sets the users who have permission to remove members from this group.
UpdateUserGroupApiRequest	withDescription(String description)	Sets the updated description of the user group.
UpdateUserGroupApiRequest	withName(String name)	Sets the updated name of the user group.
UpdateUserGroupApiRequest	withReactivateGroup()	Reactivates a deactivated user group.

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

NAME

public static final String NAME

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

CAN_ADD_MEMBERS_GROUP

public static final String CAN_ADD_MEMBERS_GROUP

See Also:

• Constant Field Values

CAN_JOIN_GROUP

public static final String CAN_JOIN_GROUP

See Also:

• Constant Field Values

CAN_LEAVE_GROUP

public static final String CAN_LEAVE_GROUP

See Also:

• Constant Field Values

CAN_MANAGE_GROUP

public static final String CAN_MANAGE_GROUP

See Also:

• Constant Field Values

CAN_MENTION_GROUP

public static final String CAN_MENTION_GROUP

See Also:

• Constant Field Values

CAN_REMOVE_MEMBERS_GROUP

public static final String CAN_REMOVE_MEMBERS_GROUP

See Also:

• Constant Field Values

DEACTIVATED

public static final String DEACTIVATED

See Also:

• Constant Field Values

Constructor Details

UpdateUserGroupApiRequest

public UpdateUserGroupApiRequest(ZulipHttpClient client,
 long groupId)

Constructs a UpdateUserGroupApiRequest.

Parameters:

client - The Zulip HTTP client

groupId - The id of the group to update

UpdateUserGroupApiRequest

public UpdateUserGroupApiRequest(ZulipHttpClient client,
 String name,
 String description,
 long groupId)

Constructs a UpdateUserGroupApiRequest.

Parameters:

client - The Zulip HTTP client

name - The updated name of the user group

description - The updated description of the user group

groupId - The id of the group to update

Method Details

withDescription

public UpdateUserGroupApiRequest withDescription(String description)

Sets the updated description of the user group.

Parameters:

description - The new description of the user group

Returns:

This UpdateUserGroupApiRequest instance

withName

public UpdateUserGroupApiRequest withName(String name)

Sets the updated name of the user group.

Parameters:

name - The new name of the user group

Returns:

This UpdateUserGroupApiRequest instance

withCanMentionGroup

@Deprecated(forRemoval=true)
public UpdateUserGroupApiRequest withCanMentionGroup(long userGroupId)

Deprecated, for removal: This API element is subject to removal in a future version.

Use withCanMentionGroup(UserGroupSetting)

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

Parameters:

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

Returns:

This UpdateUserGroupApiRequest instance

withCanMentionGroup

public UpdateUserGroupApiRequest withCanMentionGroup(UserGroupSetting userGroupSetting)

Sets the users who have permission to mention this group.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to mention this group

Returns:

This UpdateUserGroupApiRequest instance

withCanAddMembersGroup

public UpdateUserGroupApiRequest withCanAddMembersGroup(UserGroupSetting userGroupSetting)

Sets the users who have permission to add members to this group.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to add members to this group

Returns:

This UpdateUserGroupApiRequest instance

withCanJoinMembersGroup

public UpdateUserGroupApiRequest withCanJoinMembersGroup(UserGroupSetting userGroupSetting)

Sets the users who have permission to join this group.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to join this group

Returns:

This UpdateUserGroupApiRequest instance

withCanLeaveGroup

public UpdateUserGroupApiRequest withCanLeaveGroup(UserGroupSetting userGroupSetting)

Sets the users who have permission to leave this group.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to leave this group

Returns:

This UpdateUserGroupApiRequest instance

withCanManageGroup

public UpdateUserGroupApiRequest withCanManageGroup(UserGroupSetting userGroupSetting)

Sets the users who have permission to manage this group.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to manage this group

Returns:

This UpdateUserGroupApiRequest instance

withCanRemoveMembersGroup

public UpdateUserGroupApiRequest withCanRemoveMembersGroup(UserGroupSetting userGroupSetting)

Sets the users who have permission to remove members from this group.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to remove members from this group

Returns:

This UpdateUserGroupApiRequest instance

withReactivateGroup

public UpdateUserGroupApiRequest withReactivateGroup()

Reactivates a deactivated user group.

Returns:

This UpdateUserGroupApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating a user group.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful