All Classes and Interfaces

Class	Description
AddAlertWordsApiRequest	Zulip API request builder for adding user alert words.
AddApnsDeviceTokenApiRequest	Zulip API request builder for adding APNs device token to register for iOS push notifications.
AddCodePlaygroundApiRequest	Zulip API request builder for adding a code playground.
AddCodePlaygroundApiResponse	Zulip API response class for adding a code playground.
AddDefaultStreamApiRequest	Zulip API request builder for adding a default stream for new users joining the organization.
AddEmojiReactionApiRequest	Zulip API request builder for adding emoji reactions to a message.
AddFcmRegistrationTokenApiRequest	Zulip API request builder for adding an FCM registration token.
AddLinkifierApiRequest	Zulip API request builder for adding a linkifier.
AddLinkifierApiResponse	Zulip API response class for adding a linkifier.
AddUsersToGroupApiRequest	Zulip API request builder for adding users to a group.
AlertWordsApiResponse	Zulip API response class for alert words.
Anchor	Defines anchor options for matching messages.
ArchiveStreamApiRequest	Zulip API request builder for deleting a topic.
AuthenticationSettings	Defines Zulip server authentication settings.
ColorScheme	Defines Zulip UI color schemes.
CreateBigBlueButtonVideoCallApiRequest	Zulip API request builder for creating a BigBlueButton video call.
CreateBigBlueButtonVideoCallApiResponse	Zulip API response class for creating a BigBlueButton video call.
CreateDataExportApiRequest	Zulip API request builder for creating a data export.
CreateDataExportApiResponse	Zulip API response class for creating a data export.
CreateDraftsApiRequest	Zulip API request builder for creating drafts.
CreateDraftsApiResponse	Zulip API response class for creating drafts.
CreateProfileFieldApiRequest	Zulip API request builder for creating a custom profile field.
CreateProfileFieldApiResponse	Zulip API response class for creating a custom profile field.
CreateReusableInvitationLinkApiRequest	Zulip API request builder for creating a reusable invitation link.
CreateReusableInvitationLinkApiResponse	Zulip API response class for creating a reusable invitation link.
CreateSavedSnippetApiRequest	Zulip API request builder for creating a saved snippet.
CreateSavedSnippetApiResponse	Zulip API response class for creating a saved snippet.
CreateUserApiRequest	Zulip API request builder for creating a new user.
CreateUserApiResponse	Zulip API response class for creating a new user.
CreateUserGroupApiRequest	Zulip API request builder for creating a user to a group.
CustomEmoji	Defines a Zulip custom emoji.
DataExport
DataExportConsent
DataExportType	Data export types.
DeactivateOwnUserApiRequest	Zulip API request builder for deactivating the currently logged in user.
DeactivateUserApiRequest	Zulip API request builder for deactivating a user.
DeactivateUserGroupApiRequest	Zulip API request builder for deactivating a user group.
DeleteDraftApiRequest	Zulip API request builder for deleting a draft.
DeleteEmojiReactionApiRequest	Zulip API request builder for emoji emoji reactions from a message.
DeleteEventQueueApiRequest	Zulip API request builder for deleting a event queue.
DeleteLinkifierApiRequest	Zulip API request builder for deleting a linkifier.
DeleteMessageApiRequest	Zulip API request builder for deleting a message.
DeleteProfileFieldApiRequest	Zulip API request builder for deleting a custom profile field.
DeleteSavedSnippetApiRequest	Zulip API request builder for deleting a saved snippet.
DeleteScheduledMessageApiRequest	Zulip API request builder for deleting a scheduled message.
DeleteStreamApiRequest	Zulip API request builder for deleting a stream.
DeleteTopicApiRequest	Zulip API request builder for deleting a topic.
DeleteTopicApiResponse	Zulip API response class for deleting a topic.
DeleteUserAttachmentApiRequest	Zulip API request builder for deleting an attachment.
DemoteInactiveStreamOption	Options for the control of inactive stream demotion.
DesktopIconCountDisplay	Defines desktop icon count display settings.
DetachedUpload
DetachedUpload.DetachedUploadMessage
Draft	Defines a Zulip draft
DraftService
DraftType
EditDraftApiRequest	Zulip API request builder for editing a draft.
EditMessageApiRequest	Zulip API request builder for editing a message.
EditMessageApiResponse	Zulip API response class for editing a message.
EditSavedSnippetApiRequest	Zulip API request builder for editing a saved snippet.
EditScheduledMessageApiRequest	Zulip API request builder for editing a scheduled message.
EmailAddressVisibilityPolicy
Emoji	Defines a Zulip reaction emoji and associated code.
EmojiSet
Event	Defines a Zulip event.
EventListener<T>	An abstraction that defines an EventListener for receiving Zulip events.
EventPoller	Polls Zulip for real-time events.
EventPollerConfiguration	Configuration items for the EventPoller.
EventQueue	Defines a Zulip event queue.
EventService	Zulip event APIs.
ExecutableApiRequest<T>	REST API requests to be executed and return a result of type T.
ExternalAuthenticationSettings	Defines Zulip server external authentication settings.
FileUploadApiRequest	Zulip API request builder for uploading a file to the Zulip server.
FileUploadApiResponse	Zulip API response class for uploading a file to the Zulip server.
GetAllAlertWordsApiRequest	Zulip API request builder for getting all user alert words.
GetAllDataExportsApiRequest	Zulip API request builder for getting all data exports.
GetAllDataExportsApiResponse	Zulip API response class for getting all data exports.
GetAllEmojiApiRequest	Zulip API request builder for getting all custom emoji.
GetAllEmojiApiResponse	Zulip API response class for getting all emoji.
GetAllInvitationsApiRequest	Zulip API request builder for fetching invitations.
GetAllInvitationsApiResponse	Zulip API response class for fetching invitations.
GetAllUserPresenceApiRequest	Zulip API request builder for getting all user presence.
GetAllUserPresenceApiResponse	Zulip API response class for getting all users.
GetAllUsersApiRequest	Zulip API request builder for getting all users.
GetAllUsersApiResponse	Zulip API response class for getting all users.
GetApiKeyApiRequest	Zulip API request builder for getting a user API key.
GetApiKeyApiResponse	Zulip API response class for getting a user API key.
GetDataExportConsentStateApiRequest	Zulip API request builder for getting users that have consented to their private data being exported.
GetDataExportConsentStateApiResponse	Zulip API response class for getting users that have consented to their private data being exported.
GetDraftsApiRequest
GetDraftsApiResponse	Zulip API response class for getting drafts for the current user.
GetLinkifiersApiRequest	Zulip API request builder for getting all linkifiers.
GetLinkifiersApiResponse	Zulip API response class for getting all linkifiers.
GetMessageApiRequest	Zulip API request builder for getting a single message.
GetMessageApiResponse	Zulip API response class for getting the raw content from a message.
GetMessageEventsApiRequest	Zulip API request builder for receiving events from an event queue.
GetMessageEventsApiResponse	Zulip API response class for receiving a MessageEvent.
GetMessageHistoryApiRequest	Zulip API request builder for retrieving the history of a message.
GetMessageHistoryApiResponse	Zulip API response class for retrieving the history of a message.
GetMessageReadReceiptsApiRequest	Zulip API request builder for getting a list containing of IDs for all users who have marked the given message as read.
GetMessageReadReceiptsApiResponse	Zulip API response class for searching and getting message receipts.
GetMessagesApiRequest	Zulip API request builder for searching and getting messages.
GetMessagesApiResponse	Zulip API response class for searching and getting messages.
GetOwnUserApiRequest	Zulip API request builder for getting information about the user who invoked this endpoint.
GetProfileFieldsApiRequest	Zulip API request builder for getting all custom profile fields.
GetProfileFieldsApiResponse	Zulip API response class for getting all custom profile fields.
GetSavedSnippetsApiRequest	Zulip API request builder for getting all saved snippets.
GetSavedSnippetsApiResponse	Zulip API response class for getting all saved snippets.
GetScheduledMessagesApiRequest	Zulip API request builder for getting scheduled messages for the current user.
GetScheduledMessagesApiResponse	Zulip API response class for getting scheduled messages for the current user.
GetServerSettingsApiRequest	Zulip API request builder for getting server settings.
GetServerSettingsApiResponse	Zulip API response class for getting all server settings.
GetStreamApiRequest	Zulip API request builder for getting a stream by id.
GetStreamApiResponse	Zulip API response class for getting a stream by id.
GetStreamEmailAddressApiRequest	Zulip API request builder for getting the email address of a stream.
GetStreamEmailAddressApiResponse	Zulip API response class for getting a stream email address.
GetStreamIdApiRequest	Zulip API request builder for getting the id of a stream.
GetStreamIdApiResponse	Zulip API response class for getting a stream id.
GetStreamsApiRequest	Zulip API request builder for getting all streams that the user has access to.
GetStreamsApiResponse	Zulip API response class for getting all streams.
GetStreamSubscribersApiRequest	Zulip API request builder for getting all users subscribed to a stream.
GetStreamSubscribersApiResponse	Zulip API response class for getting all users subscribed to a stream.
GetStreamTopicsApiRequest	Zulip API request builder for getting stream topics.
GetStreamTopicsApiResponse	Zulip API response class for getting stream topics.
GetSubGroupsOfUserGroupApiRequest	Get the subgroups of a user group.
GetSubGroupsOfUserGroupApiResponse	Zulip API response class for getting sub groups of a user group.
GetSubscribedStreamsApiRequest	Zulip API request builder for getting streams that the user is subscribed to.
GetSubscribedStreamsApiResponse	Zulip API response class for getting subscribed streams.
GetSubscriptionStatusApiRequest	Zulip API request builder for checking whether a user is subscribed to a stream.
GetSubscriptionStatusApiResponse	Zulip API response class for getting a stream subscription status.
GetUserApiRequest	Zulip API request builder for getting a user.
GetUserApiResponse	Zulip API response class for getting a user.
GetUserAttachmentsApiRequest	Zulip API request builder for getting information about files uploaded by the user.
GetUserAttachmentsApiResponse	Zulip API response class for getting user attachment details.
GetUserGroupMembersApiRequest	Zulip API request builder for getting the members of a user group.
GetUserGroupMembersApiResponse	Zulip API response class for getting user group members.
GetUserGroupMembershipStatusApiRequest	Check whether a user is member of user group.
GetUserGroupMembershipStatusApiResponse	Zulip API response class for getting user group membership status for a user.
GetUserGroupsApiRequest	Zulip API request builder for getting all user groups.
GetUserGroupsApiResponse	Zulip API response class for getting all user groups.
GetUserPresenceApiRequest	Zulip API request builder for getting user presence information.
GetUserPresenceApiResponse	Zulip API response class for getting user presence.
GetUserStatusApiRequest	Zulip API request builder for getting a user status.
GetUserStatusApiResponse	Zulip API response class for getting a user status.
Invitation	Defines a Zulip invitation.
InvitationService	Zulip invitation APIs.
JsonUtils	A utility class to configure and get the Jackson ObjectMapper.
Linkifier	Defines a Zulip linkifier.
MarkAllAsReadApiRequest	Deprecated.
MarkReadOnScrollPolicy	Defines the mark read policy for when a user scrolls through their feed.
MarkStreamAsReadApiRequest	Zulip API request builder for marking a stream as read.
MarkTopicAsReadApiRequest	Zulip API request builder for marking a topic as read.
MatchesNarrowApiRequest	Zulip API request builder for checking if a set of messages matches a narrow.
MatchesNarrowApiResponse	Zulip API response class for checking if a set of messages matches a narrow.
Message	Defines a Zulip message
MessageEdit	Defines history for an edited Zulip message
MessageEvent	Defines a Zulip event for receiving a Message.
MessageEventListener	EventListener implementation to capture Message events.
MessageFlag	Defines a flag associated with a message.
MessageFlagsUpdateResult	Defines the result of a Zulip add or remove personal message flags request.
MessageHistory	Defines the edit history of a Zulip message.
MessageMatch	Defines message matches based on a search via a Narrow.
MessageReaction	Defines a Zulip message reaction.
MessageRecipient	Defines the recipient of a Zulip message.
MessageService	Zulip message APIs.
MessageType	Defines the type of Zulip message.
MuteTopicApiRequest	Zulip API request builder for muting or unmuting a topic.
MuteUserApiRequest	Zulip API request builder for muting a user.
Narrow	A narrow is a set of filters for Zulip messages.
NarrowableApiRequest<T>	Interface for Zulip APIs that support narrow filters.
Operation	Defines an operation to apply.
ProfileData	Defines Zulip profile data.
ProfileField	Defines a Zulip custom profile field.
ProfileFieldType	Defines the type of custom profile field.
PropagateMode	Defines the Zulip message edit propagation mode and determines which message(s) should be edited.
ReactionType	Defines the Zulip emoji reaction type.
ReactivateUserApiRequest	Zulip API request builder for reactivating a user.
RealmNameInNotificationsPolicy	Defines the policy of whether to include the organization name in the subject of message notification emails.
RegisterEventQueueApiRequest	Zulip API request builder for registering an event queue.
RegisterEventQueueApiResponse	Zulip API response class for registering an event queue.
RemoveAlertWordsApiRequest	Zulip API request builder for removing user alert words.
RemoveApnsDeviceTokenApiRequest	Zulip API request builder for removing an APNs device token.
RemoveCodePlaygroundApiRequest	Zulip API request builder for removing a code playground.
RemoveDefaultStreamApiRequest	Zulip API request builder for removing a default stream for new users joining the organization.
RemoveFcmRegistrationTokenApiRequest	Zulip API request builder for removing an FCM registration token.
RemoveUsersFromGroupApiRequest	Zulip API request builder for removing users from a group.
RenderMessageApiRequest	Zulip API request builder for rendering message to HTML.
RenderMessageApiResponse	Zulip API response class for rendering message to HTML.
ReorderLinkifiersApiRequest	Zulip API request builder for reordering linkifiers.
ReorderProfileFieldsApiRequest	Zulip API request builder for reordering custom profile fields.
ResendEmailInvitationApiRequest	Zulip API request builder for resending an email invitation.
RetentionPolicy	Defines the type of message retention policy.
RevokeEmailInvitationApiRequest	Zulip API request builder for revoking an email invitation.
RevokeReusableInvitationApiRequest	Zulip API request builder for revoking a reusable invitation.
SavedSnippet
ScheduledMessage
SendInvitationsApiRequest	Zulip API request builder for sending user invitations.
SendMessageApiRequest	Zulip API request builder for sending a message.
SendMessageApiResponse	Zulip API response class for sending a message.
SendMobilePushTestNotification	Zulip API request builder for sending mobile push test notifications.
SendScheduledMessageApiRequest	Zulip API request builder for sending a scheduled message.
SendScheduledMessageApiResponse	Zulip API response class for sending a scheduled message.
ServerService	Zulip server management APIs.
ServerSettings	Defines Zulip server settings.
SetTypingStatusApiRequest	Zulip API request builder for setting user 'typing' status.
SetTypingStatusForMessageEditApiRequest	Zulip API request builder for notifying other users whether the current user is editing a message.
SnippetService	Zulip saved snippet APIs.
Stream	Defines a Zulip stream.
StreamPostPolicy	Defines the stream post policy.
StreamService	Zulip stream APIs.
StreamSubscription	Defines a Zulip stream subscription.
StreamSubscriptionRequest	Defines a Zulip stream subscription request.
StreamSubscriptionResult	Defines a Zulip stream subscription result.
StreamSubscriptionSetting	Defines a Zulip stream subscription setting.
StreamUnsubscribeResult	Defines a Zulip stream unsubscribe result.
SubscribeStreamsApiRequest	Zulip API request builder for subscribing to a stream.
SubscribeStreamsApiResponse	Zulip API response class for subscribing to streams.
TimeoutableApiRequest<T>	REST API requests to be executed and return a result of type T.
Topic	Defines a Zulip stream topic.
TopicFollowPolicy	Defines the policy for topic following.
TopicVisibilityPolicy	Defines the type of topic visibility policy.
TypingOperation	Defines a typing operation.
UnmuteTopicInMutedStreamsPolicy	Defines the policy for unmute topic in muted streams.
UnmuteUserApiRequest	Zulip API request builder for unmuting a user.
UnsubscribeStreamsApiRequest	Zulip API request builder for unsubscribing users from a stream.
UnsubscribeStreamsApiResponse	Zulip API response class for unsubscribing from a stream.
UpdateLinkifierApiRequest	Zulip API request builder for updating a linkifier.
UpdateMessageFlagsApiRequest	Zulip API request builder for updating message flags.
UpdateMessageFlagsApiResponse	Zulip API response class for updating message flags.
UpdateMessageFlagsForNarrowApiRequest	Zulip API request builder for updating message flags with a narrow.
UpdateMessageFlagsForNarrowApiResponse	Zulip API response class for updating message flags with a narrow.
UpdateNotificationSettingsApiRequest	Deprecated.
UpdateNotificationSettingsApiResponse	Zulip API response class for updating user notification settings.
UpdateOwnUserPresenceApiRequest	Zulip API request builder for updating own user presence.
UpdateOwnUserPresenceApiResponse	Zulip API response class for updating own user presence.
UpdateOwnUserSettingsApiRequest	Zulip API request builder for updating own user settings.
UpdateOwnUserSettingsApiResponse	Zulip API response class for updating own user settings.
UpdateOwnUserStatusApiRequest	Zulip API request builder for updating own user status.
UpdateRealmNewUserDefaultSettingsApiRequest	Zulip API request builder for updating realm level default settings for new users.
UpdateRealmNewUserDefaultSettingsApiResponse	Zulip API response class for updating realm level default settings for new users.
UpdateStreamApiRequest	Zulip API request builder for updating a stream.
UpdateStreamSubscriptionSettingsApiRequest	Zulip API request builder for updating stream subscription settings.
UpdateStreamSubscriptionSettingsApiResponse	Zulip API response class for updating stream subscription settings.
UpdateUserApiRequest	Zulip API request builder to update a user.
UpdateUserByEmailApiRequest	Zulip API request builder to update a user by their email address.
UpdateUserGroupApiRequest	Zulip API request builder for updating a user group.
UpdateUserGroupSubGroupsApiRequest	Zulip API request builder for updating user group sub groups.
UpdateUserTopicPreferencesApiRequest	Zulip API request builder for updating user topic preferences.
UploadEmojiApiRequest	Zulip API request builder for uploading custom emoji images.
User	Defines a Zulip user.
UserApiResponse	Zulip API response class for getting a user.
UserAttachment	Defines a Zulip user attachment.
UserAttachmentMessage	Defines a Zulip user attachment and its association with a message.
UserGroup	Defines a Zulip user group.
UserGroupSetting	Represents a user group setting.
UserGroupSettingSerializer
UserListStyle	Defines settings for the style selected by the user for the right sidebar user list.
UserPresenceDetail	Defines details about Zulip user presence.
UserPresenceStatus	Defines the user presence status.
UserRole	Defines Zulip user roles.
UserService	Zulip user APIs.
UserStatus
VoidExecutableApiRequest	REST API requests to be executed that require no result to be returned to the called.
WebAnimateImageOption
WebChannelView	Setting for controlling the default navigation behavior when clicking on a channel link
WebHomeView	Defines options for the Zulip UI web home view.
WebStreamUnreadsCountDisplayPolicy	Defines the web stream unread count display policy.
Zulip	The Zulip client.
Zulip.Builder	Builder class for constructing the Zulip Client.
ZulipApiRequest	The default Zulip REST API request object with common behaviour for all API request types.
ZulipApiResponse	The default Zulip REST API response object.
ZulipClientException	Generic exception for any Zulip client error scenarios.
ZulipCommonsHttpClientFactory	An ZulipHttpClientFactory implementation that creates a ZulipHttpClient based on the Apache Commons HTTP Client.
ZulipConfiguration	Provides configuration options for the Zulip HTTP client library.
ZulipHttpClient	An abstraction for implementing a HTTP client for interacting with Zulip APIs.
ZulipHttpClientFactory	Factory class for creating ZulipHttpClient implementations.
ZulipRateLimitExceededException	Thrown when the Zulip server returns an HTTP response code of 429.
ZulipService	A marker interface for a class that contains one or more methods for accessing Zulip APIs.
ZulipUrlUtils	A utility class to resolve API endpoint.