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

Class ZulipApiRequest

java.lang.Object
com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest
Direct Known Subclasses:
AddAlertWordsApiRequest, AddApnsDeviceTokenApiRequest, AddCodePlaygroundApiRequest, AddDefaultStreamApiRequest, AddEmojiReactionApiRequest, AddFcmRegistrationTokenApiRequest, AddLinkifierApiRequest, AddUsersToGroupApiRequest, ArchiveStreamApiRequest, CreateBigBlueButtonVideoCallApiRequest, CreateDataExportApiRequest, CreateDraftsApiRequest, CreateProfileFieldApiRequest, CreateReusableInvitationLinkApiRequest, CreateSavedSnippetApiRequest, CreateUserApiRequest, CreateUserGroupApiRequest, DeactivateOwnUserApiRequest, DeactivateUserApiRequest, DeactivateUserGroupApiRequest, DeleteDraftApiRequest, DeleteEmojiReactionApiRequest, DeleteEventQueueApiRequest, DeleteLinkifierApiRequest, DeleteMessageApiRequest, DeleteProfileFieldApiRequest, DeleteSavedSnippetApiRequest, DeleteScheduledMessageApiRequest, DeleteStreamApiRequest, DeleteTopicApiRequest, DeleteUserAttachmentApiRequest, EditDraftApiRequest, EditMessageApiRequest, EditSavedSnippetApiRequest, EditScheduledMessageApiRequest, FileUploadApiRequest, GetAllAlertWordsApiRequest, GetAllDataExportsApiRequest, GetAllEmojiApiRequest, GetAllInvitationsApiRequest, GetAllUserPresenceApiRequest, GetAllUsersApiRequest, GetApiKeyApiRequest, GetDataExportConsentStateApiRequest, GetDraftsApiRequest, GetLinkifiersApiRequest, GetMessageApiRequest, GetMessageEventsApiRequest, GetMessageHistoryApiRequest, GetMessageReadReceiptsApiRequest, GetMessagesApiRequest, GetOwnUserApiRequest, GetProfileFieldsApiRequest, GetSavedSnippetsApiRequest, GetScheduledMessagesApiRequest, GetServerSettingsApiRequest, GetStreamApiRequest, GetStreamEmailAddressApiRequest, GetStreamIdApiRequest, GetStreamsApiRequest, GetStreamSubscribersApiRequest, GetStreamTopicsApiRequest, GetSubGroupsOfUserGroupApiRequest, GetSubscribedStreamsApiRequest, GetSubscriptionStatusApiRequest, GetUserApiRequest, GetUserAttachmentsApiRequest, GetUserGroupMembersApiRequest, GetUserGroupMembershipStatusApiRequest, GetUserGroupsApiRequest, GetUserPresenceApiRequest, GetUserStatusApiRequest, MarkAllAsReadApiRequest, MarkStreamAsReadApiRequest, MarkTopicAsReadApiRequest, MatchesNarrowApiRequest, MuteTopicApiRequest, MuteUserApiRequest, ReactivateUserApiRequest, RegisterEventQueueApiRequest, RemoveAlertWordsApiRequest, RemoveApnsDeviceTokenApiRequest, RemoveCodePlaygroundApiRequest, RemoveDefaultStreamApiRequest, RemoveFcmRegistrationTokenApiRequest, RemoveUsersFromGroupApiRequest, RenderMessageApiRequest, ReorderLinkifiersApiRequest, ReorderProfileFieldsApiRequest, ResendEmailInvitationApiRequest, RevokeEmailInvitationApiRequest, RevokeReusableInvitationApiRequest, SendInvitationsApiRequest, SendMessageApiRequest, SendMobilePushTestNotification, SendScheduledMessageApiRequest, SetTypingStatusApiRequest, SetTypingStatusForMessageEditApiRequest, SubscribeStreamsApiRequest, UnmuteUserApiRequest, UnsubscribeStreamsApiRequest, UpdateLinkifierApiRequest, UpdateMessageFlagsApiRequest, UpdateMessageFlagsForNarrowApiRequest, UpdateNotificationSettingsApiRequest, UpdateOwnUserPresenceApiRequest, UpdateOwnUserSettingsApiRequest, UpdateOwnUserStatusApiRequest, UpdateRealmNewUserDefaultSettingsApiRequest, UpdateStreamApiRequest, UpdateStreamSubscriptionSettingsApiRequest, UpdateUserApiRequest, UpdateUserGroupApiRequest, UpdateUserGroupSubGroupsApiRequest, UpdateUserTopicPreferencesApiRequest, UploadEmojiApiRequest
public class ZulipApiRequest extends Object
The default Zulip REST API request object with common behaviour for all API request types.

  • Constructor Details

  • Method Details

    • client

      protected ZulipHttpClient client()
      Gets the Zulip HTTP client.
      Returns:
      The Zulip HTTP client

    • getParams

      protected Map<String,Object> getParams()
      Gets the map of query parameters that should be passed to the Zulip API request.
      Returns:
      The map of query parameters

    • getParam

      protected Object getParam(String key)
      Gets a parameter using the specified key.
      Parameters:
      key - The key to look up the parameter value
      Returns:
      The parameter value. Null if not present

    • putParam

      protected void putParam(String key, Object value)
      Adds a value to the query parameters map.
      Parameters:
      key - The name of the query parameter
      value - The value of the query parameter

    • putParamAsJsonString

      protected void putParamAsJsonString(String key, Object value)
      Adds a value to the query parameters map serialized as a JSON string.
      Parameters:
      key - The name of the query parameter
      value - The value of the query parameter that should be JSON string serialized

    • putParamAsWrappedObject

      protected void putParamAsWrappedObject(String wrappedObjectKey, String key, Object value)
      Adds a value to query params wrapped within an object with the specified key.
      Parameters:
      wrappedObjectKey - The field name to use for the wrapped object
      key - The name of the query parameter
      value - The value of the query parameter