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, BlockUser.BlockUserRequestData.BlockUserRequest, BlockUser.GetBlockedUsersRequestData.GetBlockedUsersRequest, BlockUser.UnblockUserRequestData.UnblockUserRequest, 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.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest, 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, Draft.CreateDraftRequestData.CreateDraftRequest, Draft.DeleteDraftRequest, Draft.GetDraftRequest, Draft.QueryDraftsRequestData.QueryDraftsRequest, Event.EventSendRequestData.EventSendRequest, Event.EventSendUserCustomRequestData.EventSendUserCustomRequest, ExportUsers.ExportUsersRequestData.ExportUsersRequest, 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, MessageHistory.MessageHistoryQueryRequestData.MessageHistoryQueryRequest, Moderation.ConfigGetRequest, Moderation.ConfigGetRequestData.ConfigGetRequest, Moderation.DeleteConfigRequest, Moderation.UpsertConfigRequestData.UpsertConfigRequest, Permission.PermissionCreateRequestData.PermissionCreateRequest, Permission.PermissionDeleteRequest, Permission.PermissionGetRequest, Permission.PermissionListRequest, Permission.PermissionUpdateRequestData.PermissionUpdateRequest, Reaction.ReactionDeleteRequest, Reaction.ReactionListRequest, Reaction.ReactionSendRequestData.ReactionSendRequest, Reminder.ReminderCreateRequestData.ReminderCreateRequest, Reminder.ReminderDeleteRequest, Reminder.ReminderQueryRequestData.ReminderQueryRequest, Reminder.ReminderUpdateRequestData.ReminderUpdateRequest, Role.RoleCreateRequestData.RoleCreateRequest, Role.RoleDeleteRequest, Role.RoleListRequest, SharedLocation.GetLocationsRequestData.GetLocationsRequest, SharedLocation.UpdateLocationRequestData.UpdateLocationRequest, TaskStatus.TaskStatusGetRequest, Thread.QueryThreadsRequestData.QueryThreadsRequest, UnreadCounts.UnreadCountsBatchRequestData.UnreadCountsBatchRequest, UnreadCounts.UnreadCountsGetRequestData.UnreadCountsGetRequest, 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 java.lang.Object

Constructor Summary

Constructors

Constructor	Description
StreamRequest()

Method Summary

Modifier and Type	Method	Description
protected abstract retrofit2.Call<T>	generateCall(Client client)
protected @NotNull Client	getClient()
T	request()	Executes the request
void	requestAsync(@Nullable java.util.function.Consumer<T> onSuccess, @Nullable java.util.function.Consumer<StreamException> onError)	Executes the request asynchronously
StreamRequest<T>	withClient(Client client)	Use custom client implementation to execute requests

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamRequest

public StreamRequest()

Method Detail

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
                         @Nullable java.util.function.Consumer<T> onSuccess,
                         @Nullable
                         @Nullable java.util.function.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

Returns:

the request

getClient

@NotNull
protected @NotNull Client getClient()