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

Interface ExecutableApiRequest<T>

All Known Implementing Classes:
AddAlertWordsApiRequest, AddCodePlaygroundApiRequest, AddLinkifierApiRequest, CreateBigBlueButtonVideoCallApiRequest, CreateChannelApiRequest, CreateChannelFolderApiRequest, CreateDataExportApiRequest, CreateDraftsApiRequest, CreateMessageReminderApiRequest, CreateProfileFieldApiRequest, CreateReusableInvitationLinkApiRequest, CreateSavedSnippetApiRequest, CreateUserApiRequest, EditMessageApiRequest, FileUploadApiRequest, GetAllAlertWordsApiRequest, GetAllDataExportsApiRequest, GetAllEmojiApiRequest, GetAllInvitationsApiRequest, GetAllNavigationViewsApiRequest, GetAllUserPresenceApiRequest, GetAllUsersApiRequest, GetApiKeyApiRequest, GetChannelFoldersApiRequest, GetDataExportConsentStateApiRequest, GetDraftsApiRequest, GetLinkifiersApiRequest, GetMessageApiRequest, GetMessageHistoryApiRequest, GetMessageReadReceiptsApiRequest, GetMessageRemindersApiRequest, GetMessagesApiRequest, GetOwnUserApiRequest, GetProfileFieldsApiRequest, GetSavedSnippetsApiRequest, GetScheduledMessagesApiRequest, GetServerSettingsApiRequest, GetStreamApiRequest, GetStreamEmailAddressApiRequest, GetStreamIdApiRequest, GetStreamsApiRequest, GetStreamSubscribersApiRequest, GetStreamTopicsApiRequest, GetSubGroupsOfUserGroupApiRequest, GetSubscribedStreamsApiRequest, GetSubscriptionStatusApiRequest, GetUserApiRequest, GetUserAttachmentsApiRequest, GetUserGroupMembersApiRequest, GetUserGroupMembershipStatusApiRequest, GetUserGroupsApiRequest, GetUserPresenceApiRequest, GetUserStatusApiRequest, MatchesNarrowApiRequest, RegisterEventQueueApiRequest, RemoveAlertWordsApiRequest, RenderMessageApiRequest, SendMessageApiRequest, SendScheduledMessageApiRequest, SubscribeStreamsApiRequest, TestWelcomeBotCustomMessageApiRequest, UnsubscribeStreamsApiRequest, UpdateMessageFlagsApiRequest, UpdateMessageFlagsForNarrowApiRequest, UpdateNotificationSettingsApiRequest, UpdateOwnUserPresenceApiRequest, UpdateOwnUserSettingsApiRequest, UpdateRealmNewUserDefaultSettingsApiRequest, UpdateStreamSubscriptionSettingsApiRequest
public interface ExecutableApiRequest<T>
REST API requests to be executed and return a result of type T.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    execute()
    Invokes the HTTP client to send the request to the Zulip REST API and returns a response as type T.

  • Method Details

    • execute

      T execute() throws ZulipClientException
      Invokes the HTTP client to send the request to the Zulip REST API and returns a response as type T.
      Returns:
      The response for type T
      Throws:
      ZulipClientException - if an error occurs for the API request