Package io.getstream.chat.java.models.framework

Class StreamRequest<T extends StreamResponse>

java.lang.Object
io.getstream.chat.java.models.framework.StreamRequest<T>
Direct Known Subclasses:
App.AppCheckPushRequestData.AppCheckPushRequest, App.AppCheckSnsRequestData.AppCheckSnsRequest, App.AppCheckSqsRequestData.AppCheckSqsRequest, App.AppGetRateLimitsRequest, App.AppGetRequest, App.AppRevokeTokensRequest, App.AppUpdateRequestData.AppUpdateRequest, App.DeletePushProviderRequest, App.ListPushProvidersRequest, App.PushProviderRequestData.PushProviderRequest, Blocklist.BlocklistCreateRequestData.BlocklistCreateRequest, Blocklist.BlocklistDeleteRequest, Blocklist.BlocklistGetRequest, Blocklist.BlocklistListRequest, Blocklist.BlocklistUpdateRequestData.BlocklistUpdateRequest, Channel.AssignRoleRequestData.AssignRoleRequest, Channel.ChannelDeleteManyRequest, Channel.ChannelDeleteRequest, Channel.ChannelExportRequestData.ChannelExportRequest, Channel.ChannelExportStatusRequest, Channel.ChannelGetRequestData.ChannelGetRequest, Channel.ChannelHideRequestData.ChannelHideRequest, Channel.ChannelListRequestData.ChannelListRequest, Channel.ChannelMarkAllReadRequestData.ChannelMarkAllReadRequest, Channel.ChannelMarkReadRequestData.ChannelMarkReadRequest, Channel.ChannelMuteRequestData.ChannelMuteRequest, Channel.ChannelPartialUpdateRequestData.ChannelPartialUpdateRequest, Channel.ChannelQueryMembersRequestData.ChannelQueryMembersRequest, Channel.ChannelShowRequestData.ChannelShowRequest, Channel.ChannelTruncateRequestData.ChannelTruncateRequest, Channel.ChannelUnMuteRequestData.ChannelUnMuteRequest, Channel.ChannelUpdateRequestData.ChannelUpdateRequest, ChannelType.ChannelTypeCreateRequestData.ChannelTypeCreateRequest, ChannelType.ChannelTypeDeleteRequest, ChannelType.ChannelTypeGetRequest, ChannelType.ChannelTypeListRequest, ChannelType.ChannelTypeUpdateRequestData.ChannelTypeUpdateRequest, Command.CommandCreateRequestData.CommandCreateRequest, Command.CommandDeleteRequest, Command.CommandGetRequest, Command.CommandListRequest, Command.CommandUpdateRequestData.CommandUpdateRequest, Device.DeviceCreateRequestData.DeviceCreateRequest, Device.DeviceDeleteRequest, Device.DeviceListRequest, Event.EventSendRequestData.EventSendRequest, Event.EventSendUserCustomRequestData.EventSendUserCustomRequest, Flag.FlagCreateRequestData.FlagCreateRequest, Flag.FlagDeleteRequestData.FlagDeleteRequest, Flag.FlagMessageQueryRequestData.FlagMessageQueryRequest, Flag.QueryFlagReportsRequestData.QueryFlagReportsRequest, Flag.ReviewFlagReportRequestData.ReviewFlagReportRequest, Import.CreateImportRequestData.CreateImportRequest, Import.CreateImportUrlRequestData.CreateImportUrlRequest, Import.GetImportRequest, Import.ListImportsRequest, Message.MessageCommitRequestData.MessageCommitRequest, Message.MessageDeleteRequest, Message.MessageGetManyRequest, Message.MessageGetRepliesRequest, Message.MessageGetRequest, Message.MessagePartialUpdateRequestData.MessagePartialUpdateRequest, Message.MessageRunCommandActionRequestData.MessageRunCommandActionRequest, Message.MessageSearchRequestData.MessageSearchRequest, Message.MessageSendRequestData.MessageSendRequest, Message.MessageTranslateRequestData.MessageTranslateRequest, Message.MessageUnblockRequestData.MessageUnblockRequest, Message.MessageUpdateRequestData.MessageUpdateRequest, Permission.PermissionCreateRequestData.PermissionCreateRequest, Permission.PermissionDeleteRequest, Permission.PermissionGetRequest, Permission.PermissionListRequest, Permission.PermissionUpdateRequestData.PermissionUpdateRequest, Reaction.ReactionDeleteRequest, Reaction.ReactionListRequest, Reaction.ReactionSendRequestData.ReactionSendRequest, Role.RoleCreateRequestData.RoleCreateRequest, Role.RoleDeleteRequest, Role.RoleListRequest, TaskStatus.TaskStatusGetRequest, User.UserBanRequestData.UserBanRequest, User.UserCreateGuestRequestData.UserCreateGuestRequest, User.UserDeactivateRequestData.UserDeactivateRequest, User.UserDeleteManyRequestData.UserDeleteManyRequest, User.UserDeleteRequest, User.UserExportRequest, User.UserListRequestData.UserListRequest, User.UserMuteRequestData.UserMuteRequest, User.UserPartialUpdateRequestData.UserPartialUpdateRequest, User.UserQueryBannedRequestData.UserQueryBannedRequest, User.UserReactivateRequestData.UserReactivateRequest, User.UserRevokeTokensRequest, User.UserUnbanRequest, User.UserUnmuteRequestData.UserUnmuteRequest, User.UserUpsertRequestData.UserUpsertRequest
public abstract class StreamRequest<T extends StreamResponse> extends Object

  • Constructor Details

    • StreamRequest

      public StreamRequest()

  • Method Details

    • generateCall

      protected abstract retrofit2.Call<T> generateCall(Client client) throws StreamException
      Throws:
      StreamException

    • request

      @NotNull public T request() throws StreamException
      Executes the request
      Returns:
      response
      Throws:
      StreamException - when IO problem occurs or the stream API return an error

    • requestAsync

      public void requestAsync(@Nullable Consumer<T> onSuccess, @Nullable Consumer<StreamException> onError)
      Executes the request asynchronously
      Parameters:
      onSuccess - executed when the request is successful
      onError - executed when IO problem occurs or the stream API return an error

    • withClient

      public StreamRequest<T> withClient(Client client)
      Use custom client implementation to execute requests
      Parameters:
      client - the client implementation

    • getClient

      @NotNull protected Client getClient()