stream_feeds
library
Classes
AcceptFeedMemberInviteResponse
AcceptFollowRequest
AcceptFollowResponse
Action
ActionLog
ActionLogResponse
ActionSequence
ActivitiesQuery
A query for retrieving activities with filtering, sorting, and pagination.
ActivitiesSort
Represents a sorting operation for activities.
Activity
Represents a single activity with its data and state.
A request for adding a comment to an activity.
ActivityAddedEvent
Represents a list of activity comments with a query and state.
A query for retrieving comments for a specific activity.
ActivityData
An activity in the Stream Feeds system.
ActivityDeletedEvent
ActivityFeedbackRequest
ActivityFeedbackResponse
ActivityLocation
ActivityMarkEvent
ActivityPinnedEvent
ActivityPinResponse
ActivityProcessorConfig
ActivityReactionAddedEvent
ActivityReactionDeletedEvent
ActivityReactionUpdatedEvent
ActivityRemovedFromFeedEvent
ActivityRequest
ActivityResponse
ActivitySelectorConfig
ActivityUnpinnedEvent
A request for updating a comment to an activity.
ActivityUpdatedEvent
AddActivityRequest
AddActivityResponse
AddBookmarkRequest
AddBookmarkResponse
AddFolderRequest
AddReactionRequest
AddReactionResponse
AggregatedActivityData
Aggregated activities in the Stream Feeds system.
AggregatedActivityResponse
AggregationConfig
AIImageConfig
AITextConfig
AIVideoConfig
AndOperator <F extends FilterField >
A logical filter that matches when all provided filters match (logical AND).
AnySortComparator <T extends Object >
A type-erased wrapper for sort comparators that can work with any model type.
ApiErrorInterceptor
ApiKeyInterceptor
APNS
AppEventResponse
AppResponseFields
AppUpdatedEvent
Attachment
AttachmentFile
Cross-platform file wrapper for Stream attachments.
AttachmentUploadState
Represents the upload state of an attachment.
AudioSettings
AudioSettingsResponse
Authenticating
The WebSocket connection is established and authentication is in progress.
AuthInterceptor
Authentication interceptor that refreshes the token if
an auth error is received
AutoCompleteOperator <F extends FilterField >
An evaluation filter that matches field values starting with the specified prefix.
AutomaticReconnectionPolicy
An interface that defines a policy for determining whether the WebSocket
should attempt an automatic reconnection based on specific conditions.
AutomodPlatformCircumventionConfig
AutomodRule
AutomodSemanticFiltersConfig
AutomodSemanticFiltersRule
AutomodToxicityConfig
AWSRekognitionRule
BackgroundStateReconnectionPolicy
A reconnection policy that checks the application's lifecycle state before
allowing reconnection. This prevents reconnection when the app is in the
background to save battery and resources.
BackgroundTransformer
The default Transformer for Dio .
BackstageSettings
BackstageSettingsResponse
Ban
BanActionRequest
BanOptions
BanRequest
BanResponse
BaseOptions
A set of base settings for each Dio().
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
BlockedUserResponse
BlockListConfig
BlockListOptions
BlockListResponse
BlockListRule
BlockUsersRequest
BlockUsersResponse
BodyguardRule
BodyguardSeverityRule
BookmarkAddedEvent
BookmarkDeletedEvent
BookmarkFolderDeletedEvent
BookmarkFolderResponse
BookmarkFoldersQuery
A query for retrieving bookmark folders with filtering, sorting, and pagination.
Represents a sorting operation for bookmark folders.
BookmarkFolderUpdatedEvent
BookmarkResponse
BookmarksQuery
A query for retrieving bookmarks with filtering, sorting, and pagination.
BookmarksSort
Represents a sorting operation for bookmarks.
BookmarkUpdatedEvent
BroadcastSettings
BroadcastSettingsResponse
ByteBuffer
A sequence of bytes underlying a typed data object.
ByteData
A fixed-length, random-access sequence of bytes that also provides random
and unaligned access to the fixed-width integers and floating point
numbers represented by those bytes.
BytesBuilder
Builds a list of bytes, allowing bytes and lists of bytes to be added at the
end.
Call
CallEgress
CallIngressResponse
CallMember
CallParticipant
CallParticipantResponse
CallResponse
CallSession
CallSessionResponse
CallSettings
CallSettingsResponse
CallType
CancelToken
Controls cancellation of Dio 's requests.
CastPollVoteRequest
CdnClient
Content Delivery Network (CDN) client for file operations.
Channel
ChannelConfig
ChannelConfigWithInfo
ChannelMember
ChannelMemberLookup
ChannelMemberResponse
ChannelMute
ChannelPushPreferences
ChannelResponse
Command
A list of comments with a query and state.
Represents a list of comment reactions with a query and state.
A query for retrieving comment reactions with filtering, sorting, and pagination.
Represents a sorting operation for comment reactions.
A query for retrieving replies to a specific comment.
Represents a list of comment replies with a query and state.
A query for retrieving comments with filtering, sorting, and pagination.
Interface for comment data that can be sorted.
ComparableField <T >
A wrapper class for values that implements Comparable .
ComparisonOperator <F extends FilterField , V extends Object ? >
A filter operator that compares field values using comparison operations.
CompositeAppSettings
CompositeReconnectionPolicy
A composite reconnection policy that combines multiple policies using a
logical operator (AND/OR). This allows for complex reconnection
logic by combining multiple conditions.
ConfigOverrides
ConfigResponse
Connected
The WebSocket is fully connected and authenticated.
Connecting
The WebSocket is attempting to establish a connection.
ConnectionIdInterceptor
Interceptor that injects the connection id in the request params
ConnectionRecoveryHandler
A connection recovery handler with intelligent reconnection management.
ConnectUserDetailsRequest
ContainsOperator <F extends FilterField , V extends Object ? >
A list filter that matches lists containing the specified value.
ContentCountRuleParameters
CreateBlockListRequest
CreateBlockListResponse
CreateDeviceRequest
CreateFeedsBatchRequest
CreateFeedsBatchResponse
CreateGuestRequest
CreateGuestResponse
CreatePollOptionRequest
CreatePollRequest
CurrentPlatform
Platform detection utility for identifying the current runtime environment.
CustomActionRequest
Data
DecayFunctionConfig
DefaultApi
DefaultRetryStrategy
Default implementation of RetryStrategy that uses exponential backoff
with jitter.
DeleteActivitiesRequest
DeleteActivitiesResponse
DeleteActivityReactionResponse
DeleteActivityRequest
DeleteActivityResponse
DeleteBookmarkFolderResponse
DeleteBookmarkResponse
DeleteFeedResponse
DeleteMessageRequest
DeleteModerationConfigResponse
DeleteReactionRequest
DeleteUserRequest
Device
DeviceResponse
Dio
Dio enables you to make HTTP requests easily.
DioMixin
Disconnected
The WebSocket connection is closed and not available for communication.
Disconnecting
The WebSocket connection is in the process of being closed.
DisconnectionSource
Represents the source or cause of a WebSocket disconnection.
Disposable
A convenience class to represent a disposable object.
DraftPayloadResponse
DraftResponse
DurationResponse
DynamicTokenProvider
A token provider that dynamically loads fresh JWT tokens using a custom function.
EgressHLSResponse
EgressResponse
EgressRTMPResponse
EgressTaskConfig
EgressUser
Endian
Endianness of number representation.
EnrichedActivity
EnrichedReaction
EntityCreator
EntityCreatorResponse
EpochDateTimeConverter
A JsonConverter that converts between DateTime and epoch nanoseconds as int .
EqualOperator <F extends FilterField , V extends Object ? >
A comparison filter that matches values equal to the specified value.
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
EvaluationOperator <F extends FilterField >
A filter operator that performs text-based evaluation operations.
EventNotificationSettings
ExistsOperator <F extends FilterField >
A filter that matches based on field existence or absence.
ExternalStorage
Failure
Represents failed result.
FCM
Feed
A feed represents a collection of activities and provides methods to interact with them.
FeedAddActivityRequest
A request for adding an activity to feeds.
FeedCreatedEvent
FeedData
A feed in the Stream Feeds system.
FeedDeletedEvent
FeedGroup
FeedGroupChangedEvent
FeedGroupDeletedEvent
FeedId
A unique feed identifier.
FeedInput
FeedInputData
Input data for creating or updating a feed.
FeedMemberAddedEvent
FeedMemberData
A member of a feed.
FeedMemberRemovedEvent
FeedMemberRequest
FeedMemberRequestData
A member request for adding to a feed.
FeedMemberResponse
FeedMemberUpdatedEvent
FeedQuery
A query for retrieving and managing feed data from Stream Feeds.
FeedRequest
FeedResponse
FeedsConfig
Configuration settings for the Stream Feeds SDK.
FeedsPreferences
FeedsQuery
A query for retrieving feeds with filtering, sorting, and pagination.
FeedsReactionResponse
FeedsSort
Represents a sorting operation for feeds.
FeedState
Represents the current state of a feed.
FeedStateNotifier
Manages the state of a feed and handles state updates.
FeedUpdatedEvent
Field
FileUploadConfig
FileUploadRequest
FileUploadResponse
Filter <F extends FilterField >
A filter for querying data with type-safe field specifications.
Flag
FlagRequest
FlagResponse
FlagUserOptions
Float32List
A fixed-length list of IEEE 754 single-precision binary floating-point
numbers that is viewable as a TypedData .
Float32x4
Four 32-bit floating point values.
Float32x4List
A fixed-length list of Float32x4 numbers that is viewable as a
TypedData .
Float64List
A fixed-length list of IEEE 754 double-precision binary floating-point
numbers that is viewable as a TypedData .
Float64x2
Float64x2 immutable value type and operations.
Float64x2List
A fixed-length list of Float64x2 numbers that is viewable as a
TypedData .
FollowBatchRequest
FollowBatchResponse
FollowCreatedEvent
FollowData
A follow relationship between feeds.
FollowDeletedEvent
FollowRequest
FollowResponse
FollowsQuery
A query for retrieving follow relationships with filtering, sorting, and pagination.
FollowsSort
Represents a sorting operation for follows.
FollowUpdatedEvent
FormData
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
FrameRecordingEgressConfig
FrameRecordingResponse
FrameRecordingSettingsResponse
FrameRecordSettings
FullUserResponse
FusedTransformer
A Transformer that has a fast path for decoding UTF8-encoded JSON.
If the response is utf8-encoded JSON and no custom decoder is specified in the RequestOptions , this transformer
is significantly faster than the default SyncTransformer and the BackgroundTransformer .
This improvement is achieved by using a fused Utf8Decoder and JsonDecoder to decode the response,
which is faster than decoding the utf8-encoded JSON in two separate steps, since
Dart uses a special fast decoder for this case.
See https://github.com/dart-lang/sdk/blob/5b2ea0c7a227d91c691d2ff8cbbeb5f7f86afdb9/sdk/lib/_internal/vm/lib/convert_patch.dart#L40
GeofenceSettings
GeofenceSettingsResponse
GetActivityResponse
GetApplicationResponse
GetBlockedUsersResponse
GetConfigResponse
GetFollowSuggestionsResponse
GetOGResponse
GetOrCreateFeedRequest
GetOrCreateFeedResponse
GoogleVisionConfig
GreaterOperator <F extends FilterField , V extends Object ? >
A comparison filter that matches values greater than the specified value.
GreaterOrEqualOperator <F extends FilterField , V extends Object ? >
A comparison filter that matches values greater than or equal to the specified value.
HarmConfig
The headers class for requests and responses.
Interceptor that sets additional headers for all requests.
HealthCheckInfo
HealthCheckPingEvent
HLSEgressConfig
HLSSettings
HLSSettingsResponse
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient .
ImageContentParameters
ImageData
ImageRuleParameters
Images
ImageSize
ImageUploadRequest
ImageUploadResponse
IngressAudioEncodingOptions
IngressAudioEncodingResponse
IngressSettings
IngressSettingsResponse
IngressVideoEncodingOptions
IngressVideoEncodingResponse
IngressVideoLayer
IngressVideoLayerResponse
Initialized
The initial state before any connection attempt has been made.
InOperator <F extends FilterField , V extends Object ? >
A list filter that matches values contained within a specified list.
Int16List
A fixed-length list of 16-bit signed integers that is viewable as a
TypedData .
Int32List
A fixed-length list of 32-bit signed integers that is viewable as a
TypedData .
Int32x4
Int32x4 and operations.
Int32x4List
A fixed-length list of Int32x4 numbers that is viewable as a
TypedData .
Int64List
A fixed-length list of 64-bit signed integers that is viewable as a
TypedData .
Int8List
A fixed-length list of 8-bit signed integers.
Interceptor
Interceptor helps to deal with RequestOptions , Response ,
and DioException during the lifecycle of a request
before it reaches users.
Interceptors
A Queue-Model list for Interceptor s.
InterceptorsWrapper
A helper class to create interceptors in ease.
InternetAvailabilityReconnectionPolicy
A reconnection policy that checks for internet connectivity before allowing
reconnection. This prevents unnecessary reconnection attempts when there's no
network available.
LabelThresholds
LayoutSettings
LessOperator <F extends FilterField , V extends Object ? >
A comparison filter that matches values less than the specified value.
LessOrEqualOperator <F extends FilterField , V extends Object ? >
A comparison filter that matches values less than or equal to the specified value.
LifecycleStateProvider
A utility class for monitoring application lifecycle state changes.
LimitsSettings
LimitsSettingsResponse
ListBlockListResponse
ListDevicesResponse
ListOperator <F extends FilterField , V extends Object ? >
A filter operator that performs list-based matching operations.
ListParam <T >
Indicates a param being used as queries or form data,
and how does it gets formatted.
LLMConfig
LLMRule
LoggingInterceptor
Interceptor dedicated to logging
LogicalOperator <F extends FilterField >
A filter operator that combines multiple filters using logical operations.
LogInterceptor
LogInterceptor is used to print logs during network requests.
It should be the last interceptor added,
otherwise modifications by following interceptors will not be logged.
This is because the execution of interceptors is in the order of addition.
MarkActivityRequest
MarkReviewedRequest
MemberLookup
MembershipLevelResponse
Message
MessageReminder
MessageResponse
ModerationActionConfig
ModerationConfigsQuery
A query for retrieving moderation configs with filtering, sorting, and pagination.
ModerationConfigsSort
Represents a sorting operation for moderation configs.
ModerationCustomActionEvent
ModerationFlaggedEvent
ModerationFlagResponse
ModerationMarkReviewedEvent
ModerationPayload
ModerationV2Response
MultipartFile
An upload content that is a part of MultipartRequest.
This doesn't need to correspond to a physical file.
MutableEventEmitter <T extends WsEvent >
A mutable event emitter for WebSocket events with resolver support.
MutableSharedEmitter <T >
A mutable emitter that allows emitting events of type T to multiple listeners.
MutableStateEmitter <T >
A mutable state emitter that allows updating the current state value.
MuteRequest
MuteResponse
NetworkStateProvider
A utility class for monitoring network connectivity changes.
NoiseCancellationSettings
NotificationConfig
NotificationContext
NotificationFeedUpdatedEvent
NotificationSettings
NotificationStatusResponse
NotificationTarget
NotificationTrigger
OCRRule
OnlyUserID
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
OrOperator <F extends FilterField >
A logical filter that matches when any of the provided filters match (logical OR).
OwnUser
OwnUserResponse
PathExistsOperator <F extends FilterField >
A filter that checks for the existence of nested JSON paths within a field.
PinActivityResponse
Poll
PollClosedFeedEvent
PollData
A poll in the Stream Feeds system.
PollDeletedFeedEvent
PollOption
PollOptionData
A poll option in the Stream Feeds system.
PollOptionInput
PollOptionRequest
PollOptionResponse
PollOptionResponseData
PollResponse
PollResponseData
PollsQuery
A query for retrieving polls with filtering, sorting, and pagination.
PollsSort
Represents a sorting operation for polls.
PollUpdatedFeedEvent
PollVote
PollVoteCastedFeedEvent
PollVoteChangedFeedEvent
PollVoteData
A poll vote in the Stream Feeds system.
PollVoteRemovedFeedEvent
PollVoteResponse
PollVoteResponseData
PollVotesQuery
A query for retrieving poll votes with filtering, sorting, and pagination.
PollVotesResponse
PollVotesSort
Represents a sorting operation for poll votes.
PrivacySettings
PrivacySettingsResponse
PushNotificationConfig
PushNotificationsConfig
Push notification configuration settings.
PushPreferenceInput
PushPreferences
PushProviderInfo
Information about the push provider.
Quality
QueryActivitiesRequest
QueryActivitiesResponse
QueryActivityReactionsRequest
QueryActivityReactionsResponse
QueryBookmarkFoldersRequest
QueryBookmarkFoldersResponse
QueryBookmarksRequest
QueryBookmarksResponse
QueryFeedMembersRequest
QueryFeedMembersResponse
QueryFeedsRequest
QueryFeedsResponse
QueryFollowsRequest
QueryFollowsResponse
QueryModerationConfigsRequest
QueryModerationConfigsResponse
QueryOperator <F extends FilterField >
An evaluation filter that performs full-text search on field content.
QueryPollsRequest
QueryPollsResponse
QueryPollVotesRequest
QueryReviewQueueRequest
QueryReviewQueueResponse
QueryUsersPayload
QueryUsersResponse
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor in ease.
RankingConfig
Reaction
ReactionGroupResponse
ReactionResponse
ReadReceipts
ReadReceiptsResponse
RecordingEgressConfig
RecordSettings
RecordSettingsResponse
RedirectRecord
A record that records the redirection happens during requests,
including status code, request method, and the location.
RejectFeedMemberInviteResponse
RejectFollowRequest
RejectFollowResponse
ReminderResponseData
RepliesMeta
RequestInterceptorHandler
The handler for interceptors to handle before the request has been sent.
RequestOptions
The internal request option class that is the eventual result after
BaseOptions and Options are composed.
Response <T >
The Response class contains the payload (could be transformed)
that respond from the request, and other information of the response.
ResponseBody
The response wrapper class for adapters.
ResponseInterceptorHandler
The handler for interceptors to handle after respond.
Result <T >
A discriminated union that encapsulates a successful outcome with a value of type T
or a failure with an arbitrary Object error.
RetryStrategy
Interface that encapsulates the logic for computing delays for failed actions that need to be
retried.
ReviewQueueItem
ReviewQueueItemResponse
RingSettings
RingSettingsResponse
RTMPEgressConfig
RTMPIngress
RTMPLocation
RTMPSettings
RTMPSettingsResponse
RuleBuilderAction
RuleBuilderCondition
RuleBuilderConditionGroup
RuleBuilderConfig
RuleBuilderRule
ScreensharingSettings
ScreensharingSettingsResponse
ServerInitiated
A disconnection that was initiated by the server.
SessionSettings
SessionSettingsResponse
SFUIDLastSeen
SharedEmitter <T >
A read-only emitter that allows listening for events of type T.
SharedLocation
SharedLocationResponse
SharedLocationResponseData
SharedLocationsResponse
SingleFollowResponse
Sort <T extends Object >
A sort specification that defines how to order a collection of objects.
SortComparator <T extends Object , V extends Object >
A comparator that can sort model instances by extracting comparable values.
SortField <T extends Object >
A sortable field definition that maps remote field names to local value extractors.
SortParam
SortParamRequest
SpeechSegmentConfig
SRTIngress
StateEmitter <T >
A state-aware emitter that maintains the current value and emits state changes.
StaticTokenProvider
A token provider that uses a static token for a specific user.
StoriesConfig
StreamApiError
An API error response from the Stream API.
StreamAttachment
Represents a file attachment with type information and upload state.
StreamAttachmentUploader
Uploads StreamAttachment objects to remote storage.
StreamFeedsClient
Stream Feeds client for building scalable newsfeeds and activity streams.
StreamLogger
StreamWebSocketClient
A WebSocket client with connection management and event handling.
StreamWebSocketEngine <Inc , Out >
A WebSocket engine implementation that handles low-level WebSocket operations.
STTEgressConfig
SubmitActionRequest
SubmitActionResponse
Success <T >
Represents successful result.
SyncTransformer
If you want to custom the transformation of request/response data,
you can provide a Transformer by your self, and replace
the transformer by setting the Dio.transformer .
SystemEnvironment
A class that represents the environment in which the Stream SDK is
running.
SystemEnvironmentManager
A manager class to handle the current SystemEnvironment .
SystemInitiated
A disconnection that was initiated by system-level conditions.
TargetResolution
TextContentParameters
TextRuleParameters
A threaded comment in the Stream Feeds system.
Thresholds
ThumbnailResponse
ThumbnailsSettings
ThumbnailsSettingsResponse
TokenManager
Manages user authentication tokens with caching and thread-safe access.
TokenProvider
A provider for loading user authentication tokens.
TranscriptionSettings
TranscriptionSettingsResponse
Transformer
Transformer allows changes to the request/response data before
it is sent/received to/from the server.
TranslationSettings
TypedData
A typed view of a sequence of bytes.
TypedDataList <E >
A TypedData fixed-length List -view on the bytes of buffer .
TypingIndicators
TypingIndicatorsResponse
Uint16List
A fixed-length list of 16-bit unsigned integers that is viewable as a
TypedData .
Uint32List
A fixed-length list of 32-bit unsigned integers that is viewable as a
TypedData .
Uint64List
A fixed-length list of 64-bit unsigned integers that is viewable as a
TypedData .
Uint8ClampedList
A fixed-length list of 8-bit unsigned integers.
Uint8List
A fixed-length list of 8-bit unsigned integers.
UnblockUsersRequest
UnblockUsersResponse
UnfollowResponse
UnHealthyConnection
A disconnection caused by failed connection health checks.
UnknownWSClientEvent
UnknownWSEvent
UnpinActivityResponse
UpdateActivityPartialRequest
UpdateActivityPartialResponse
UpdateActivityRequest
UpdateActivityResponse
UpdateBlockListRequest
UpdateBlockListResponse
UpdateBookmarkFolderRequest
UpdateBookmarkFolderResponse
UpdateBookmarkRequest
UpdateBookmarkResponse
UpdateFeedMembersRequest
UpdateFeedMembersResponse
UpdateFeedRequest
UpdateFeedResponse
UpdateFollowRequest
UpdateFollowResponse
UpdateLiveLocationRequest
UpdatePollOptionRequest
UpdatePollPartialRequest
UpdatePollRequest
UpdateUserPartialRequest
UpdateUsersPartialRequest
UpdateUsersRequest
UpdateUsersResponse
UploadedAttachment
Represents a successfully uploaded attachment.
UploadedFile
Represents an uploaded file result from the CDN.
UploadStateFailed
Upload state indicating the attachment upload failed.
UploadStateInProgress
Upload state indicating the attachment upload is in progress.
UploadStatePreparing
Upload state indicating the attachment is being prepared for upload.
UploadStateSuccess
Upload state indicating the attachment was successfully uploaded.
UpsertActivitiesRequest
UpsertActivitiesResponse
UpsertConfigRequest
UpsertConfigResponse
UpsertPushPreferencesRequest
UpsertPushPreferencesResponse
User
Model for the user's info.
UserBannedEvent
UserCreatedWithinParameters
UserCustomPropertyParameters
UserData
A user in the Stream Feeds system.
UserDeactivatedEvent
UserInitiated
A disconnection that was explicitly requested by the application.
UserMute
UserMutedEvent
UserMuteResponse
UserReactivatedEvent
UserRequest
UserResponse
UserResponseCommonFields
UserResponsePrivacyFields
UserRuleParameters
UserToken
A user authentication token for Stream Core API access.
UserUpdatedEvent
VelocityFilterConfig
VelocityFilterConfigRule
VideoCallRuleConfig
VideoContentParameters
VideoOrientation
VideoRuleParameters
VideoSettings
VideoSettingsResponse
VoteData
WebSocketAutomaticReconnectionPolicy
A reconnection policy that checks if automatic reconnection is enabled
based on the current state of the WebSocket connection.
WebSocketConnectionState
Represents the current state of a WebSocket connection.
WebSocketEngine <Outgoing >
Interface for WebSocket engine implementations.
WebSocketEngineListener <Incoming >
Interface for receiving WebSocket engine events.
WebSocketHealthListener
Interface for receiving WebSocket health monitoring events.
WebSocketHealthMonitor
A health monitor for WebSocket connections with ping/pong management.
WebSocketMessageCodec <Incoming , Outgoing >
Interface for WebSocket message encoding and decoding.
WebSocketOptions
Configuration options for establishing WebSocket connections.
WHIPIngress
WSAuthMessage
WsAuthMessageRequest
WSClientEvent <T extends WsEvent >
WSEvent <T extends WsEvent >
WsEvent
WsRequest
Mixins
OptionsMixin
The mixin class for options that provides common attributes.
Typedefs
ConnectionIdGetter
= String ? Function()
ConnectionStateEmitter StateEmitter <WebSocketConnectionState
A state emitter for WebSocket connection state changes.
DefaultTransformer SyncTransformer
DioError DioException
DioError describes the exception info when a request failed.
DioErrorType DioExceptionType
Deprecated in favor of DioExceptionType and will be removed in future major versions.
DioExceptionReadableStringBuilder
= String Function(DioException e
The readable string builder's signature of
DioException.readableStringBuilder .
DioMediaType
The type (alias) for specifying the content-type of the MultipartFile.
EventEmitter T extends WsEvent >
= SharedEmitter <T >
A read-only event emitter for WebSocket events.
EventResolver T extends WsEvent >
= T? Function(T event
A function that inspects an event and optionally resolves it into a
more specific or refined version of the same type.
Finder
= T? Function<T extends StreamLogger >([dynamic criteria
The signature that iterates header fields.
InterceptorErrorCallback
= void Function(DioException error , ErrorInterceptorHandler handler
The signature of Interceptor.onError .
InterceptorSendCallback
= void Function(RequestOptions options , RequestInterceptorHandler handler
The signature of Interceptor.onRequest .
InterceptorSuccessCallback
= void Function(Response response , ResponseInterceptorHandler handler
The signature of Interceptor.onResponse .
IsLoggableValidator
= bool Function(Priority Tag
JsonDecodeCallback
= FutureOr Function(String
The callback definition for decoding a JSON string.
JsonEncodeCallback
= FutureOr <String Function(Object
The callback definition for encoding a JSON object.
LifecycleStateEmitter StateEmitter <LifecycleState
A type alias for a state emitter that emits LifecycleState values.
LogPrint
= void Function(InterceptStep step , Object object
Function used to print the log
MessageBuilder
= String Function()
MutableConnectionStateEmitter MutableStateEmitter <WebSocketConnectionState
A mutable state emitter for WebSocket connection state changes.
NetworkStateEmitter StateEmitter <NetworkState
A type alias for a state emitter that emits NetworkState values.
OnBatchUploadProgress
= void Function(String attachmentId , double progress
Callback for tracking batch upload progress.
OnUploadProgress
= void Function(double progress
Callback for tracking upload progress.
PingRequestBuilder
= WsRequest Function([HealthCheckInfo ?info
A function that builds ping requests for health checks.
ProgressCallback
= void Function(int count , int total
The type of a progress listening callback when sending or receiving data.
RequestEncoder
= FutureOr <List <int Function(String request , RequestOptions options
The type of a request encoding callback.
ResponseDecoder
= FutureOr <String ? Function(List <int responseBytes , RequestOptions options , ResponseBody responseBody
The type of a response decoding callback.
SortFieldComparator T >
= int Function(T? a , T? b , SortDirection direction , NullOrdering nullOrdering
A comparator function that compares two instances of type T based on
a specified field, sort direction, and null ordering.
SortFieldValueGetter T , V >
= V? Function(T
Signature for a function that retrieves a sortable field value of type V from
an instance of type T.
Tag String
UserTokenLoader
= Future <UserToken Function(String userId
A function that loads user tokens.
ValidateStatus
= bool Function(int ?status
The type of a response status code validate callback.
WebSocketProvider
= WebSocketChannel Function(WebSocketOptions options
Signature for a function that creates a WebSocketChannel based on WebSocketOptions .
