stream_chat_flutter_core
library
Classes
-
AcceptInviteResponse
-
Model response for Channel.acceptInvite api call
-
Action
-
The class that contains the information about an action
-
AddMembersResponse
-
Model response for Channel.addMembers api call
-
AsyncCache<T>
-
Runs asynchronous functions and caches the result for a period of time.
-
AsyncMemoizer<T>
-
A class for running an asynchronous function exactly once and caching its
result.
-
Attachment
-
The class that contains the information about an attachment
-
AttachmentFile
-
The class that contains the information about an attachment file
-
AttachmentFileUploader
-
Class responsible for uploading images and files to a given channel
-
BaseOptions
-
The common config for the Dio instance.
dio.options
is a instance of BaseOptions
-
BetterStreamBuilder<T extends Object>
-
A more efficient StreamBuilder
It requires initialData and will rebuild
only when the new data is different than the current data
The comparator is used to check if the new data is different
-
CancelableCompleter<T>
-
A completer for a CancelableOperation.
-
CancelableOperation<T>
-
An asynchronous operation that can be cancelled.
-
Channel
-
Class that manages a specific channel.
-
ChannelClientState
-
The class that handles the state of the channel listening to the events.
-
ChannelConfig
-
The class that contains the information about the configuration of a channel
-
ChannelListController
-
Controller used for loading more data and controlling pagination in
ChannelListCore.
-
ChannelListCore
-
ChannelListCore is a simplified class that allows fetching a list of
channels while exposing UI builders.
A ChannelListController is used to reload and paginate data.
-
ChannelModel
-
The class that contains the information about a channel
-
ChannelsBloc
-
Widget dedicated to the management of a channel list with pagination
ChannelsBloc is used together with ChannelListCore to manage a list of
Channels with pagination, re-ordering, querying and other operations
associated with Channels.
-
ChannelsBlocState
-
The current state of the ChannelsBloc.
-
ChannelState
-
The class that contains the information about a channel
-
ChannelStateResponse
-
Model response for Channel.query api call
-
ChatPersistenceClient
-
A simple client used for persisting chat data locally.
-
ChunkedStreamReader<T>
-
Utility class for reading elements from a chunked stream.
-
ClientState
-
The class that handles the state of the channel listening to the events
-
Command
-
The class that contains the information about a command
-
ConnectGuestUserResponse
-
Model response for StreamChatClient.connectGuestUser api call
-
Connectivity
-
Discover network connectivity configurations: Distinguish between WI-FI and cellular, check WI-FI status and more.
-
Debounce
-
Creates a debounced function that delays invoking
func
until after wait
milliseconds have elapsed since the last time the debounced function was
invoked. The debounced function comes with a Debounce.cancel method to cancel
delayed func
invocations and a Debounce.flush method to immediately invoke them.
Provide leading
and/or trailing
to indicate whether func
should be
invoked on the leading
and/or trailing
edge of the wait
interval.
The func
is invoked with the last arguments provided to the call
function. Subsequent calls to the debounced function return the result of
the last func
invocation.
-
DelegatingEventSink<T>
-
Simple delegating wrapper around an EventSink.
-
DelegatingFuture<T>
-
A wrapper that forwards calls to a Future.
-
DelegatingSink<T>
-
Simple delegating wrapper around a Sink.
-
DelegatingStream<T>
-
Simple delegating wrapper around a Stream.
-
DelegatingStreamConsumer<T>
-
Simple delegating wrapper around a StreamConsumer.
-
DelegatingStreamSink<T>
-
Simple delegating wrapper around a StreamSink.
-
DelegatingStreamSubscription<T>
-
Simple delegating wrapper around a StreamSubscription.
-
Device
-
The class that contains the information about a device
-
EmptyResponse
-
Model response for empty responses
-
ErrorResponse
-
Model response for StreamChatNetworkError data
-
ErrorResult
-
A result representing a thrown error.
-
Event
-
The class that contains the information about an event
-
EventChannel
-
The channel embedded in the event object
-
EventSinkBase<T>
-
An abstract class that implements EventSink in terms of onAdd,
onError, and onClose methods.
-
EventType
-
This class defines some basic event types
-
Failed
-
-
Filter
-
Stream supports a limited set of filters for querying channels,
users and members. The example below shows how to filter for channels
of type messaging where the current user is a member
-
FutureGroup<T>
-
A collection of futures waits until all added Futures complete.
-
GetMessageResponse
-
Model response for StreamChatClient.getMessage api call
-
GetMessagesByIdResponse
-
Model response for Channel.getMessagesById api call
-
InProgress
-
-
InviteMembersResponse
-
Model response for Channel.inviteMembers api call
-
IOSinkBase
-
An abstract class that implements
dart:io
's IOSink
's API in terms of
onAdd, onError, onClose, and onFlush methods.
-
LazyLoadScrollView
-
Wrapper around a Scrollable which triggers onEndOfPage/onStartOfPage the Scrollable
reaches to the start or end of the view extent.
-
LazyStream<T>
-
A Stream wrapper that forwards to another Stream that's initialized
lazily.
-
Level
-
Levels to control logging output. Logging can be enabled to include all
levels above certain Level. Levels are ordered using an integer
value Level.value. The predefined Level constants below are sorted as
follows (in descending order): Level.SHOUT, Level.SEVERE,
Level.WARNING, Level.INFO, Level.CONFIG, Level.FINE, Level.FINER,
Level.FINEST, and Level.ALL.
-
ListDevicesResponse
-
Model response for StreamChatClient.getDevices api call
-
Header Item
-
ListItem
-
Represents an item in a the user stream list.
Header items are prefixed with the key
HEADER
While users are prefixed
with USER
.
-
ListUserItem
-
User Item
-
Logger
-
Use a Logger to log debug messages.
-
Member
-
The class that contains the information about the user membership
in a channel
-
Message
-
The class that contains the information about a message
-
MessageListController
-
Controller used for paginating data in
ChannelListView
-
MessageListCore
-
MessageListCore is a simplified class that allows fetching a list of
messages while exposing UI builders.
-
MessageSearchBloc
-
MessageSearchBloc is used to manage a list of messages with pagination.
This class can be used to load messages, perform queries, etc.
-
MessageSearchBlocState
-
The current state of the MessageSearchBloc
-
MessageSearchListController
-
Controller used for paginating data in
ChannelListView
-
MessageSearchListCore
-
MessageSearchListCore is a simplified class that allows searching for
messages across channels while exposing UI builders.
A MessageSearchListController is used to load and paginate data.
-
MultipartFile
-
A file to be uploaded as part of a
MultipartRequest
. This doesn't need to
correspond to a physical file.
-
Mute
-
The class that contains the information about a muted user
-
NullStreamSink<T>
-
A StreamSink that discards all events.
-
OGAttachmentResponse
-
Model response for
Client.enrichUrl
api call.
-
Options
-
Every request can pass an Options object which will be merged with
Dio.options
-
OwnUser
-
The class that defines the own user model.
-
Pagination options.
-
PartialUpdateChannelResponse
-
Model response for Channel.updatePartial api call
-
PartialUpdateUserRequest
-
Request model for the
client.partialUpdateUser
api call.
-
Preparing
-
-
QueryBannedUsersResponse
-
Model response for StreamChatClient.queryBannedUsers api call
-
QueryChannelsResponse
-
Model response for StreamChatClient.queryChannels api call
-
QueryMembersResponse
-
Model response for StreamChatClient.queryChannels api call
-
QueryReactionsResponse
-
Model response for
channel.getReactions
api call
-
QueryRepliesResponse
-
Model response for Channel.getReplies api call
-
QueryUsersResponse
-
Model response for StreamChatClient.queryUsers api call
-
Reaction
-
The class that defines a reaction
-
Read
-
The class that defines a read event
-
RejectInviteResponse
-
Model response for Channel.rejectInvite api call
-
RemoveMembersResponse
-
Model response for Channel.removeMembers api call
-
RequestOptions
-
-
RestartableTimer
-
A non-periodic timer that can be restarted any number of times.
-
Result<T>
-
The result of a computation.
-
ResultFuture<T>
-
A Future wrapper that provides synchronous access to the result of the
wrapped Future once it's completed.
-
SearchMessagesResponse
-
Model response for StreamChatClient.search api call
-
SendActionResponse
-
Model response for Channel.sendAction api call
-
SendFileResponse
-
Model response for Channel.sendFile api call
-
SendImageResponse
-
Model response for Channel.sendImage api call
-
SendMessageResponse
-
Model response for Channel.sendMessage api call
-
SendReactionResponse
-
Model response for Channel.sendReaction api call
-
SingleSubscriptionTransformer<S, T>
-
A transformer that converts a broadcast stream into a single-subscription
stream.
-
SortOption<T>
-
Sorting options
-
StreamChannel
-
Widget used to provide information about the channel to the widget tree
-
StreamChannelState
-
-
StreamChatClient
-
The official Dart client for Stream Chat,
a service for building chat applications.
This library can be used on any Dart project and on both mobile and web apps
with Flutter.
-
StreamChatCore
-
Widget used to provide information about the chat to the widget tree.
This Widget is used to react to life cycle changes and system updates.
When the app goes into the background, the websocket connection is kept
alive for two minutes before being terminated.
-
StreamChatCoreState
-
State class associated with StreamChatCore.
-
StreamCloser<T>
-
A StreamTransformer that allows the caller to forcibly close the
transformed Stream.
-
StreamCompleter<T>
-
A single-subscription stream where the contents are provided later.
-
StreamGroup<T>
-
A collection of streams whose events are unified and sent through a central
stream.
-
StreamQueue<T>
-
An asynchronous pull-based interface for accessing stream events.
-
StreamQueueTransaction<T>
-
A transaction on a StreamQueue, created by StreamQueue.startTransaction.
-
StreamSinkBase<T>
-
An abstract class that implements StreamSink in terms of onAdd,
onError, and onClose methods.
-
StreamSinkCompleter<T>
-
A sink where the destination is provided later.
-
StreamSinkTransformer<S, T>
-
A StreamSinkTransformer transforms the events being passed to a sink.
-
StreamSplitter<T>
-
A class that splits a single source stream into an arbitrary number of
(single-subscription) streams (called "branch") that emit the same events.
-
StreamZip<T>
-
A stream that combines the values of other streams.
-
SubscriptionStream<T>
-
A Stream adapter for a StreamSubscription.
-
Success
-
-
SyncResponse
-
Model response for StreamChatClient.sync api call
-
Throttle
-
Creates a throttled function that only invokes
func
at most once per
every wait
milliseconds. The throttled function comes with a Throttle.cancel
method to cancel delayed func
invocations and a Throttle.flush method to
immediately invoke them. Provide leading
and/or trailing
to indicate
whether func
should be invoked on the leading
and/or trailing
edge of the wait
timeout.
The func
is invoked with the last arguments provided to the
throttled function. Subsequent calls to the throttled function return the
result of the last func
invocation.
-
TranslateMessageResponse
-
Model response for StreamChatClient.queryChannels api call
-
UpdateChannelResponse
-
Model response for Channel.update api call
-
UpdateMessageResponse
-
Model response for StreamChatClient.updateMessage api call
-
UpdateUsersResponse
-
Model response for StreamChatClient.updateUser api call
-
UploadState
-
Union class to hold various UploadState of a attachment.
-
User
-
Class that defines a Stream Chat User.
-
UserListController
-
Controller used for paginating data in
ChannelListView
-
UserListCore
-
UserListCore is a simplified class that allows fetching users while
exposing UI builders.
A UserListController is used to load and paginate data.
-
UsersBloc
-
Widget dedicated to the management of a users list with pagination.
-
UsersBlocState
-
The current state of the UsersBloc
-
ValueResult<T>
-
A result representing a returned value.
Enums
-
ChatErrorCode
-
Complete list of errors that are returned by the API
together with the description and API code.
-
ConnectionStatus
-
Used to notify the WS connection status
-
ConnectivityResult
-
Connection status check result.
-
DioErrorType
-
-
ListFormat
-
ListFormat specifies the array format
(a single parameter with multiple parameter or multiple parameters with the same name)
and the separator for array items.
-
Location
-
-
MessageSendingStatus
-
Enum defining the status of a sending message
-
PushProvider
-
Provider used to send push notifications.
-
QueryDirection
-
Specifies query direction for pagination
-
ResponseType
-
ResponseType indicates which transformation should
be automatically applied to the response data by Dio.
Functions
-
chatErrorCodeFromCode(int code)
→ ChatErrorCode?
-
-
collectBytes(Stream<List<int>> source)
→ Future<Uint8List>
-
Collects an asynchronous sequence of byte lists into a single list of bytes.
-
collectBytesCancelable(Stream<List<int>> source)
→ CancelableOperation<Uint8List>
-
Collects an asynchronous sequence of byte lists into a single list of bytes.
-
debounce(Function func, Duration wait, {bool leading = false, bool trailing = true, Duration? maxWait})
→ Debounce
-
TopLevel lambda to create Debounce functions.
-
defaultMessageFilter(String currentUserId)
→ bool Function(Message)
-
Default filter for the message list
-
subscriptionTransformer<T>({Future handleCancel(StreamSubscription<T>)?, void handlePause(StreamSubscription<T>)?, void handleResume(StreamSubscription<T>)?})
→ StreamTransformer<T, T>
-
Creates a StreamTransformer that modifies the behavior of subscriptions to
a stream.
-
throttle(Function func, Duration wait, {bool leading = true, bool trailing = true})
→ Throttle
-
TopLevel lambda to create Throttle functions.
-
typedStreamTransformer<S, T>(StreamTransformer transformer)
→ StreamTransformer<S, T>
-
Creates a wrapper that coerces the type of
transformer
.