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

Class UserService

java.lang.Object

com.github.jamesnetherton.zulip.client.api.user.UserService

All Implemented Interfaces:

ZulipService

public class UserService
extends Object
implements ZulipService

Zulip user APIs.

Constructor Summary

Constructors

Constructor	Description
UserService(ZulipHttpClient client)	Constructs a UserService.

Method Summary

Modifier and Type	Method	Description
AddAlertWordsApiRequest	addAlertWords(String... alertWords)	Adds user alert words.
AddUsersToGroupApiRequest	addUsersToGroup(long groupId, long... userIds)	Add sers to a group.
CreateUserApiRequest	createUser(String email, String fullName, String password)	Create a new user.
CreateUserGroupApiRequest	createUserGroup(String name, String description, long... userIds)	Create a new user group.
DeactivateUserApiRequest	deactivate(long userId)	Deactivate a user.
DeactivateOwnUserApiRequest	deactivateOwnUser()	Deactivates the user who invokes this endpoint.
DeactivateUserGroupApiRequest	deactivateUserGroup(long groupId)	Deactivates a user group.
DeleteUserAttachmentApiRequest	deleteAttachment(long attachmentId)	Deletes an attachment.
DeleteOwnProfileDataApiRequest	deleteOwnProfileData(List<Integer> fieldIds)	Removes the current user's data for the specified custom profile fields.
GetAllAlertWordsApiRequest	getAllAlertWords()	Gets all user alert words.
GetAllUserPresenceApiRequest	getAllUserPresence()	Gets all user presence details.
GetAllUsersApiRequest	getAllUsers()	Gets all users.
GetBotApiKeyApiRequest	getBotApiKey(long botId)	Fetches the API key for a bot user.
GetOwnUserApiRequest	getOwnUser()	Get information about the user who invokes this endpoint
GetSubGroupsOfUserGroupApiRequest	getSubGroupsOfUserGroup(long userGroupId)	Get the subgroups of a user group.
GetUserApiRequest	getUser(long userId)	Gets a user by id.
GetUserApiRequest	getUser(String email)	Gets a user by the given Zulip display email address.
GetUserAttachmentsApiRequest	getUserAttachments()	Get user attachments.
GetUserChannelsApiRequest	getUserChannels(long userId)	Gets the list of channels the target user is subscribed to.
GetUserGroupMembersApiRequest	getUserGroupMembers(long userGroupId)	Get user group members.
GetUserGroupMembershipStatusApiRequest	getUserGroupMembershipStatus(long userGroupId, long userId)	Check whether a user is member of a user group.
GetUserGroupsApiRequest	getUserGroups()	Get all user groups.
GetUserPresenceApiRequest	getUserPresence(String email)	Get user presence information.
GetUserStatusApiRequest	getUserStatus(long userId)	Gets a user status.
MuteUserApiRequest	mute(long userId)	Mute a user.
ReactivateUserApiRequest	reactivate(long userId)	Reactivates a user.
RegenerateApiKeyApiRequest	regenerateApiKey()	Regenerates the current user's API key.
RegenerateBotApiKeyApiRequest	regenerateBotApiKey(long botId)	Regenerates the API key of a bot user.
RemoveAlertWordsApiRequest	removeAlertWords(String... alertWords)	Removes user alert words.
RemoveUsersFromGroupApiRequest	removeUsersFromGroup(long groupId, long... userIds)	Remove users from a group.
SetTypingStatusApiRequest	setTyping(TypingOperation operation, long... userIds)	Sets user 'typing' status
SetTypingStatusApiRequest	setTyping(TypingOperation operation, long streamId, String topic)	Sets user 'typing' status
SetTypingStatusForMessageEditApiRequest	setTypingForMessageEdit(long messageId, TypingOperation operation)	Notifies other users whether the current user is editing a message
UnmuteUserApiRequest	unmute(long userId)	Unmute a user.
UpdateNotificationSettingsApiRequest	updateNotificationSettings()	Deprecated.
UpdateOwnProfileDataApiRequest	updateOwnProfileData(List<Map<String,Object>> data)	Updates the current user's custom profile field data.
UpdateOwnUserPresenceApiRequest	updateOwnUserPresence(UserPresenceStatus status)	Fetches presence details for the current client user.
UpdateOwnUserSettingsApiRequest	updateOwnUserSettings()	Updates settings for the user who invokes this endpoint.
UpdateOwnUserStatusApiRequest	updateOwnUserStatus()	Updates aspects of the status for the user who invokes this endpoint.
UpdateUserApiRequest	updateUser(long userId)	Update a user.
UpdateUserByEmailApiRequest	updateUser(String email)	Update a user by their email address.
UpdateUserGroupApiRequest	updateUserGroup(long groupId)	Updates a user group.
UpdateUserGroupApiRequest	updateUserGroup(String name, String description, long groupId)	Updates a user group.
UpdateUserGroupSubGroupsApiRequest	updateUserGroupSubGroups(long userGroupId)	Updates user group sub groups.
UpdateUserStatusApiRequest	updateUserStatus(long userId)	Updates settings for a given user.

Methods inherited from class java.lang.Object

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

Constructor Details

UserService

public UserService(ZulipHttpClient client)

Constructs a UserService.

Parameters:

client - The Zulip HTTP client

Method Details

createUser

public CreateUserApiRequest createUser(String email,
 String fullName,
 String password)

Create a new user.

Parameters:

email - The email address of the new user

fullName - The name of the new user

password - The password of the new user

Returns:

The CreateUserApiRequest builder object

See Also:

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

deactivate

public DeactivateUserApiRequest deactivate(long userId)

Deactivate a user.

Parameters:

userId - The id of the user to deactivate

Returns:

The DeactivateUserApiRequest builder object

See Also:

• https://zulip.com/api/deactivate-user

deactivateOwnUser

public DeactivateOwnUserApiRequest deactivateOwnUser()

Deactivates the user who invokes this endpoint.

Returns:

The DeactivateOwnUserApiRequest builder object

See Also:

• https://zulip.com/api/deactivate-own-user

reactivate

public ReactivateUserApiRequest reactivate(long userId)

Reactivates a user.

Parameters:

userId - The user id to reactivate

Returns:

The ReactivateUserApiRequest builder object

See Also:

• https://zulip.com/api/reactivate-user

setTyping

public SetTypingStatusApiRequest setTyping(TypingOperation operation,
 long... userIds)

Sets user 'typing' status

Parameters:

operation - The typing operation to apply

userIds - Array of user ids to add to set the typing status for

Returns:

The SetTypingStatusApiRequest builder object

See Also:

• https://zulip.com/api/set-typing-status

setTyping

public SetTypingStatusApiRequest setTyping(TypingOperation operation,
 long streamId,
 String topic)

Sets user 'typing' status

Parameters:

operation - The typing operation to apply

streamId - The id of the stream in which the message is being typed

topic - The name of the topic in which the message is being typed

Returns:

The SetTypingStatusApiRequest builder object

See Also:

• https://zulip.com/api/set-typing-status

setTypingForMessageEdit

public SetTypingStatusForMessageEditApiRequest setTypingForMessageEdit(long messageId,
 TypingOperation operation)

Notifies other users whether the current user is editing a message

Parameters:

messageId - The id of the message being edited

operation - The typing operation to apply

Returns:

The SetTypingStatusForMessageEditApiRequest builder object

See Also:

• https://zulip.com/api/set-typing-status-for-message-edit

createUserGroup

public CreateUserGroupApiRequest createUserGroup(String name,
 String description,
 long... userIds)

Create a new user group.

Parameters:

name - The name of the user group

description - The user group description

userIds - Array of user ids to add to the group

Returns:

The CreateUserGroupApiRequest builder object

See Also:

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

deactivateUserGroup

public DeactivateUserGroupApiRequest deactivateUserGroup(long groupId)

Deactivates a user group.

Parameters:

groupId - The id of the user group to deactivate

Returns:

The DeactivateUserGroupApiRequest builder object

See Also:

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

updateUserGroup

public UpdateUserGroupApiRequest updateUserGroup(long groupId)

Updates a user group.

Parameters:

groupId - The id of the group to update

Returns:

The UpdateUserGroupApiRequest builder object

See Also:

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

updateUserGroup

public UpdateUserGroupApiRequest updateUserGroup(String name,
 String description,
 long groupId)

Updates a user group.

Parameters:

name - The updated name of the user group

description - The updated description of the user group

groupId - The id of the group to update

Returns:

The UpdateUserGroupApiRequest builder object

See Also:

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

addUsersToGroup

public AddUsersToGroupApiRequest addUsersToGroup(long groupId,
 long... userIds)

Add sers to a group.

Parameters:

groupId - The id of the group to add users to

userIds - Array of user ids to add to the group

Returns:

The AddUsersToGroupApiRequest builder object

See Also:

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

removeUsersFromGroup

public RemoveUsersFromGroupApiRequest removeUsersFromGroup(long groupId,
 long... userIds)

Remove users from a group.

Parameters:

groupId - The id of the group to remove users from

userIds - Array of user ids to remove from the group

Returns:

The RemoveUsersFromGroupApiRequest builder object

See Also:

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

getUserGroups

public GetUserGroupsApiRequest getUserGroups()

Get all user groups.

Returns:

The GetUserGroupsApiRequest builder object

See Also:

• https://zulip.com/api/get-user-groups

getUserGroupMembers

public GetUserGroupMembersApiRequest getUserGroupMembers(long userGroupId)

Get user group members.

Parameters:

userGroupId - The id of the user group to fetch members from

Returns:

The GetUserGroupMembersApiRequest builder object

See Also:

• https://zulip.com/api/get-user-group-members

getUserGroupMembershipStatus

public GetUserGroupMembershipStatusApiRequest getUserGroupMembershipStatus(long userGroupId,
 long userId)

Check whether a user is member of a user group.

Parameters:

userGroupId - The id of the user group on which the user belongs

userId - The id of the user

Returns:

The GetUserGroupMembershipStatusApiRequest builder object

See Also:

• https://zulip.com/api/get-is-user-group-member

updateNotificationSettings

@Deprecated
public UpdateNotificationSettingsApiRequest updateNotificationSettings()

Deprecated.

Update user notification settings.

Returns:

The UpdateNotificationSettingsApiRequest builder object

See Also:

• https://zulip.com/api/update-notification-settings

getOwnUser

public GetOwnUserApiRequest getOwnUser()

Get information about the user who invokes this endpoint

Returns:

The GetOwnUserApiRequest builder object

See Also:

• https://zulip.com/api/get-own-user

getAllUsers

public GetAllUsersApiRequest getAllUsers()

Gets all users.

Returns:

The GetAllUsersApiRequest builder object

See Also:

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

getUser

public GetUserApiRequest getUser(long userId)

Gets a user by id.

Parameters:

userId - The id of the user to get

Returns:

The GetUserApiRequest builder object

See Also:

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

getUser

public GetUserApiRequest getUser(String email)

Gets a user by the given Zulip display email address.

Parameters:

email - The Zulip display email address of the user to get

Returns:

The GetUserApiRequest builder object

See Also:

• https://zulip.com/api/get-user-by-email

updateUser

public UpdateUserApiRequest updateUser(long userId)

Update a user.

Parameters:

userId - The id of the user to update

Returns:

The UpdateUserApiRequest builder object

See Also:

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

updateUser

public UpdateUserByEmailApiRequest updateUser(String email)

Update a user by their email address.

Parameters:

email - The email address of the user to update

Returns:

The UpdateUserByEmailApiRequest builder object

See Also:

• https://zulip.com/api/update-user-by-email

getUserPresence

public GetUserPresenceApiRequest getUserPresence(String email)

Get user presence information.

Parameters:

email - The email address of the user to get presence details for

Returns:

The GetUserPresenceApiRequest builder object

See Also:

• https://zulip.com/api/get-user-presence

getAllUserPresence

public GetAllUserPresenceApiRequest getAllUserPresence()

Gets all user presence details.

Returns:

The GetAllUserPresenceApiRequest builder object

See Also:

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

updateOwnUserPresence

public UpdateOwnUserPresenceApiRequest updateOwnUserPresence(UserPresenceStatus status)

Fetches presence details for the current client user.

Parameters:

status - The status of the user

Returns:

The UpdateOwnUserPresenceApiRequest builder object

See Also:

• https://zulip.com/api/update-presence

getUserAttachments

public GetUserAttachmentsApiRequest getUserAttachments()

Get user attachments.

Returns:

The GetUserAttachmentsApiRequest builder object

See Also:

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

deleteAttachment

public DeleteUserAttachmentApiRequest deleteAttachment(long attachmentId)

Deletes an attachment.

Parameters:

attachmentId - The id of the attachment to delete

Returns:

The DeleteUserAttachmentApiRequest builder object

See Also:

• https://zulip.com/api/remove-attachment

mute

public MuteUserApiRequest mute(long userId)

Mute a user.

Parameters:

userId - The id of the user to mute

Returns:

The MuteUserApiRequest builder object

See Also:

• https://zulip.com/api/mute-user

updateOwnUserStatus

public UpdateOwnUserStatusApiRequest updateOwnUserStatus()

Updates aspects of the status for the user who invokes this endpoint.

Returns:

The UpdateOwnUserStatusApiRequest builder object

See Also:

• https://zulip.com/api/update-status

updateOwnUserSettings

public UpdateOwnUserSettingsApiRequest updateOwnUserSettings()

Updates settings for the user who invokes this endpoint.

Returns:

The UpdateOwnUserSettingsApiRequest builder object

See Also:

• https://zulip.com/api/update-settings

updateUserStatus

public UpdateUserStatusApiRequest updateUserStatus(long userId)

Updates settings for a given user.

Returns:

The UpdateUserStatusApiRequest builder object

See Also:

• https://zulip.com/api/update-status-for-user

unmute

public UnmuteUserApiRequest unmute(long userId)

Unmute a user.

Parameters:

userId - The id of the user to unmute

Returns:

The UnmuteUserApiRequest builder object

See Also:

• https://zulip.com/api/unmute-user

getSubGroupsOfUserGroup

public GetSubGroupsOfUserGroupApiRequest getSubGroupsOfUserGroup(long userGroupId)

Get the subgroups of a user group.

Parameters:

userGroupId - The ID of the user group

Returns:

The GetSubGroupsOfUserGroupApiRequest builder object

See Also:

• https://zulip.com/api/get-user-group-subgroups

updateUserGroupSubGroups

public UpdateUserGroupSubGroupsApiRequest updateUserGroupSubGroups(long userGroupId)

Updates user group sub groups.

Parameters:

userGroupId - The ID of the user group to update

Returns:

The UpdateUserGroupSubGroupsApiRequest builder object

See Also:

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

addAlertWords

public AddAlertWordsApiRequest addAlertWords(String... alertWords)

Adds user alert words.

Parameters:

alertWords - An array of strings, where each string is an alert word (or phrase)

Returns:

The AddAlertWordsApiRequest builder object

See Also:

• https://zulip.com/api/add-alert-words

getAllAlertWords

public GetAllAlertWordsApiRequest getAllAlertWords()

Gets all user alert words.

Returns:

The GetAllAlertWordsApiRequest builder object

See Also:

• https://zulip.com/api/get-alert-words

removeAlertWords

public RemoveAlertWordsApiRequest removeAlertWords(String... alertWords)

Removes user alert words.

Parameters:

alertWords - An array of strings, where each string is an alert word (or phrase)

Returns:

The RemoveAlertWordsApiRequest builder object

See Also:

• https://zulip.com/api/remove-alert-words

getUserStatus

public GetUserStatusApiRequest getUserStatus(long userId)

Gets a user status.

Parameters:

userId - The ID of the user to fetch the status for

Returns:

The GetUserStatusApiRequest builder object

See Also:

• https://zulip.com/api/get-user-status

getBotApiKey

public GetBotApiKeyApiRequest getBotApiKey(long botId)

Fetches the API key for a bot user. Only the bot's owner and organization administrators have access to a bot's API key.

Parameters:

botId - The user ID of the target bot

Returns:

The GetBotApiKeyApiRequest builder object

See Also:

• https://zulip.com/api/get-bot-api-key

regenerateBotApiKey

public RegenerateBotApiKeyApiRequest regenerateBotApiKey(long botId)

Regenerates the API key of a bot user. Only the bot's owner and organization administrators have access.

Parameters:

botId - The user ID of the target bot

Returns:

The RegenerateBotApiKeyApiRequest builder object

See Also:

• https://zulip.com/api/regenerate-bot-api-key

regenerateApiKey

public RegenerateApiKeyApiRequest regenerateApiKey()

Regenerates the current user's API key. This will immediately log out all devices registered for push notifications.

Returns:

The RegenerateApiKeyApiRequest builder object

See Also:

• https://zulip.com/api/regenerate-api-key

updateOwnProfileData

public UpdateOwnProfileDataApiRequest updateOwnProfileData(List<Map<String,Object>> data)

Updates the current user's custom profile field data.

Parameters:

data - List of maps each with id (integer) and value (string or null) entries

Returns:

The UpdateOwnProfileDataApiRequest builder object

See Also:

• https://zulip.com/api/update-profile-data

deleteOwnProfileData

public DeleteOwnProfileDataApiRequest deleteOwnProfileData(List<Integer> fieldIds)

Removes the current user's data for the specified custom profile fields.

Parameters:

fieldIds - List of custom profile field IDs to remove data for

Returns:

The DeleteOwnProfileDataApiRequest builder object

See Also:

• https://zulip.com/api/remove-profile-data

getUserChannels

public GetUserChannelsApiRequest getUserChannels(long userId)

Gets the list of channels the target user is subscribed to.

Parameters:

userId - The ID of the user to get channels for

Returns:

The GetUserChannelsApiRequest builder object

See Also:

• https://zulip.com/api/get-user-channels