stream_feed library

Classes

Activity
In its simplest form, an activity consists of an actor, a verb, an object, and a target.
ActivityMarker
Convenient class to mark feed as seen / read
ActivityUpdate
For updating only parts of one or more activities by changing, adding, or removing fields.
AggregatedFeed
Aggregated feeds are helpful for grouping activities.
AttachmentFile
Contains information about an attachment file.
CollectionEntry
Collections enable you to store information to Stream.
Content
Represents custom data related to the content you want to track using Stream Analytics.
Crop
Crops an image based on supplied _width,_height and eventually types
Engagement
A type of event that contains details about a user's interactions with an Activity.
EnrichmentFlags
Flags to indicate the API to enrich activities with additional info like user reactions and count
FeedId
A feed identifier based on slug and userId.
FileStorageClient
This API endpoint allows the uploading of files to, and deleting files from, a Stream-provided CDN.
Filter
Note: passing both id_lteandid_gte is not supported.
FlatFeed
Flat is the default feed type - and the only feed type that you can follow.
Follow
Model for the follower of a feed
Followers
Followers of a feed used as a field in FollowStats
Following
Following of a feed used in FollowStats as field
FollowStats
Following stats for a feed
ForeignIdTimePair
A model that wraps foreignID and time
GenericEnrichedActivity<A, Ob, T, Or>
Enrichment is a concept in Stream that enables our API to work quickly and efficiently.
Group<T>
An aggregated group type.
ImageStorageClient
Image and files have separate clients (e.g. images can be resized, whereas files cannot).
Impression
A type of event that contains details about activities a user has viewed.
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.
Logger
Use a Logger to log debug messages.
NextParams
NotificationFeedMeta
NotificationGroup<T>
A notification group.
OgAudio
OG Audio object
OgImage
OG Image object
OgVideo
OG Video object
OpenGraphData
Open graph data from a website.
PaginatedActivities<A, Ob, T, Or>
Paginated activities feed
PaginatedActivitiesGroup<A, Ob, T, Or>
Paginated activities group feed
PaginatedReactions<A, Ob, T, Or>
Paginated Reaction
Reaction
Reactions are a special kind of data that can be used to capture user interaction with specific activities.
ReactionsClient
Provides methods for reacting to Activities.
RealtimeMessage<A, Ob, T, Or>
A realtime message for changes to one or many feeds.
Resize
Resize an image based on supplied _width,_height and eventually _type
StreamAnalytics
Sends out analytic events to the Stream service. We recommend tracking every event for each user. This allows you to gain a better understanding of that user's interests. Common examples include:
StreamFeedClient
The client class that manages API calls and authentication.
StreamHttpClientOptions
Client options to modify StreamHttpClient
StreamUser
Stream allows you to store user information and embed them inside activities or use them for personalization.
Subscription
Thumbnail
Create a Thumbnail of an image based on supplied _width,_height and eventually cropTypes and resizeType
Token
The JWT auth token for a specific feed.
User
Stream allows you to store user information and embed them inside activities or use them for personalization.
UserData
Data about a user

Enums

CropType
The type of crop
FeedsError
Enumerates the list of errors that are returned by the API.
Location
Location of the cluster closest to your user.
LookupAttribute
Lookup objects based on attributes
ResizeType
The type of resize
Runner
Different sides on which you can run this StreamFeedClient on

Extensions

CropX on CropType
Extensions for CropType.
FeedsErrorCodeX on FeedsError
Extensions on FeedsError.
LocationX on Location
Convenient class Extension to on Location enum
LookupAttributeX on LookupAttribute
Convenient class Extension on LookupAttribute enum
MapX on Map<K?, V?>
Useful extension functions for Map
ResizeX on ResizeType
Extensions for ResizeType.
StringX on String
Useful extension functions for String

Functions

checkArgument(bool expression, [String? message]) → void
Throws an ArgumentError if the given expression is false.
checkNotNull<T>(T reference, [String? message]) → T
Throws an ArgumentError if the given reference is null. Otherwise, returns the reference parameter.
createActivityReference(String id) String
Returns a new collection reference string in the form SA:
createCollectionReference(String? collection, String? id) String
Returns a new collection reference string in the form SO:
createReactionReference(String id) String
Returns a new reaction reference string in the form SR:
createUserReference(String id) String
Returns a new user reference string in the form SU:
feedsErrorCodeFromCode(int code) FeedsError?
parseNext(String next) NextParams

Typedefs

EnrichedActivity = GenericEnrichedActivity<User, String, String, String>
Convenient typedef for GenericEnrichedActivity with default parameters ready to use and suitable for most use cases
OnReceiveProgress = void Function(int receivedBytes, int totalBytes)
OnSendProgress = void Function(int sentBytes, int totalBytes)

Exceptions / Errors

StreamApiException
Exception related to api calls
StreamFeedsError
A custom Exception for printing Stream Feeds specific errors.
StreamFeedsNetworkError
A custom Exception for printing http-related Stream Feeds errors.