Class ZulipApiRequest
java.lang.Object
com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest
- Direct Known Subclasses:
AddAlertWordsApiRequest, AddApnsDeviceTokenApiRequest, AddCodePlaygroundApiRequest, AddDefaultStreamApiRequest, AddEmojiReactionApiRequest, AddFcmRegistrationTokenApiRequest, AddLinkifierApiRequest, AddNavigationViewApiRequest, AddRealmDomainApiRequest, AddUsersToGroupApiRequest, ArchiveStreamApiRequest, CheckThumbnailStatusApiRequest, CreateBigBlueButtonVideoCallApiRequest, CreateChannelApiRequest, CreateChannelFolderApiRequest, CreateConstructorGroupsVideoCallApiRequest, CreateDataExportApiRequest, CreateDraftsApiRequest, CreateGoogleMeetVideoCallApiRequest, CreateMessageReminderApiRequest, CreateNextcloudTalkVideoCallApiRequest, CreateProfileFieldApiRequest, CreateReusableInvitationLinkApiRequest, CreateSavedSnippetApiRequest, CreateUserApiRequest, CreateUserGroupApiRequest, CreateWebexVideoCallApiRequest, DeactivateEmojiApiRequest, DeactivateOwnUserApiRequest, DeactivateRealmApiRequest, DeactivateUserApiRequest, DeactivateUserGroupApiRequest, DeleteAvatarApiRequest, DeleteDataExportApiRequest, DeleteDraftApiRequest, DeleteEmojiReactionApiRequest, DeleteEventQueueApiRequest, DeleteLinkifierApiRequest, DeleteMessageApiRequest, DeleteMessageReminderApiRequest, DeleteNavigationViewApiRequest, DeleteOwnProfileDataApiRequest, DeleteProfileFieldApiRequest, DeleteRealmDomainApiRequest, DeleteSavedSnippetApiRequest, DeleteScheduledMessageApiRequest, DeleteStreamApiRequest, DeleteTopicApiRequest, DeleteUserAttachmentApiRequest, EditDraftApiRequest, EditMessageApiRequest, EditSavedSnippetApiRequest, EditScheduledMessageApiRequest, FileUploadApiRequest, GetAllAlertWordsApiRequest, GetAllDataExportsApiRequest, GetAllEmojiApiRequest, GetAllInvitationsApiRequest, GetAllNavigationViewsApiRequest, GetAllUserPresenceApiRequest, GetAllUsersApiRequest, GetApiKeyApiRequest, GetBotApiKeyApiRequest, GetBotStorageApiRequest, GetChannelFoldersApiRequest, GetDataExportConsentStateApiRequest, GetDraftsApiRequest, GetEventsApiRequest, GetFileTemporaryUrlApiRequest, GetLinkifiersApiRequest, GetMessageApiRequest, GetMessageEventsApiRequest, GetMessageHistoryApiRequest, GetMessageReadReceiptsApiRequest, GetMessageRemindersApiRequest, GetMessagesApiRequest, GetOwnUserApiRequest, GetProfileFieldsApiRequest, GetRealmDomainsApiRequest, GetSavedSnippetsApiRequest, GetScheduledMessagesApiRequest, GetServerSettingsApiRequest, GetStreamApiRequest, GetStreamEmailAddressApiRequest, GetStreamIdApiRequest, GetStreamsApiRequest, GetStreamSubscribersApiRequest, GetStreamTopicsApiRequest, GetSubGroupsOfUserGroupApiRequest, GetSubscribedStreamsApiRequest, GetSubscriptionStatusApiRequest, GetUserApiRequest, GetUserAttachmentsApiRequest, GetUserChannelsApiRequest, GetUserGroupMembersApiRequest, GetUserGroupMembershipStatusApiRequest, GetUserGroupsApiRequest, GetUserPresenceApiRequest, GetUserStatusApiRequest, JwtFetchApiKeyApiRequest, MarkAllAsReadApiRequest, MarkStreamAsReadApiRequest, MarkTopicAsReadApiRequest, MatchesNarrowApiRequest, MuteTopicApiRequest, MuteUserApiRequest, ReactivateUserApiRequest, RegenerateApiKeyApiRequest, RegenerateBotApiKeyApiRequest, RegisterClientDeviceApiRequest, RegisterE2EMobilePushDevice, RegisterEventQueueApiRequest, RemoveAlertWordsApiRequest, RemoveApnsDeviceTokenApiRequest, RemoveBotStorageApiRequest, RemoveClientDeviceApiRequest, RemoveCodePlaygroundApiRequest, RemoveDefaultStreamApiRequest, RemoveFcmRegistrationTokenApiRequest, RemoveUsersFromGroupApiRequest, RenderMessageApiRequest, ReorderChannelFoldersApiRequest, ReorderLinkifiersApiRequest, ReorderProfileFieldsApiRequest, ReportMessageApiRequest, ResendEmailInvitationApiRequest, RevokeEmailInvitationApiRequest, RevokeReusableInvitationApiRequest, SendE2EMobilePushTestNotification, SendInvitationsApiRequest, SendMessageApiRequest, SendMobilePushTestNotification, SendScheduledMessageApiRequest, SetTypingStatusApiRequest, SetTypingStatusForMessageEditApiRequest, SubscribeStreamsApiRequest, TestWelcomeBotCustomMessageApiRequest, UnmuteUserApiRequest, UnsubscribeStreamsApiRequest, UpdateBotStorageApiRequest, UpdateChannelFolderApiRequest, UpdateLinkifierApiRequest, UpdateMessageFlagsApiRequest, UpdateMessageFlagsForNarrowApiRequest, UpdateNavigationViewApiRequest, UpdateNotificationSettingsApiRequest, UpdateOwnProfileDataApiRequest, UpdateOwnUserPresenceApiRequest, UpdateOwnUserSettingsApiRequest, UpdateOwnUserStatusApiRequest, UpdateProfileFieldApiRequest, UpdateRealmDomainApiRequest, UpdateRealmNewUserDefaultSettingsApiRequest, UpdateStreamApiRequest, UpdateStreamSubscriptionSettingsApiRequest, UpdateUserApiRequest, UpdateUserGroupApiRequest, UpdateUserGroupSubGroupsApiRequest, UpdateUserStatusApiRequest, UpdateUserTopicPreferencesApiRequest, UploadAvatarApiRequest, UploadEmojiApiRequest
The default Zulip REST API request object with common behaviour for all API request types.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedZulipApiRequest(ZulipHttpClient client) Constructs aZulipApiRequest. -
Method Summary
Modifier and TypeMethodDescriptionprotected ZulipHttpClientclient()Gets the Zulip HTTP client.protected ObjectGets a parameter using the specified key.protected <T> TGets a parameter using the specified key.Gets the map of query parameters that should be passed to the Zulip API request.protected voidAdds a value to the query parameters map.protected voidputParamAsJsonString(String key, Object value) Adds a value to the query parameters map serialized as a JSON string.protected voidputParamAsWrappedObject(String wrappedObjectKey, String key, Object value) Adds a value to query params wrapped within an object with the specified key.
-
Constructor Details
-
ZulipApiRequest
Constructs aZulipApiRequest.- Parameters:
client- The Zulip HTTP client
-
-
Method Details
-
client
-
getParams
-
getParam
-
getParam
-
putParam
-
putParamAsJsonString
-
putParamAsWrappedObject
Adds a value to query params wrapped within an object with the specified key.- Parameters:
wrappedObjectKey- The field name to use for the wrapped objectkey- The name of the query parametervalue- The value of the query parameter
-