FlatFeed class

Flat is the default feed type - and the only feed type that you can follow.

It's not possible to follow either aggregated or notification feeds.

You can create new feed groups based on the flat type in the dashboard.

Constructors

FlatFeed(FeedId feedId, FeedAPI feed, {Token? userToken, String? secret, FeedSubscriber? subscriber})
Initialize a feed object
const

Properties

feed → FeedAPI
The stream client this feed is constructed from
finalinherited
feedId FeedId
The feed id
finalinherited
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
secret String?
Your API secret
finalinherited
subscriber → FeedSubscriber?
finalinherited
userToken Token?
Your user token obtain via the dashboard. Required if you are using the sdk client side
finalinherited

Methods

addActivities(Iterable<Activity> activities) Future<List<Activity>>
Adds the given activities to the feed
inherited
addActivity(Activity activity) Future<Activity>
Adds the given Activity to the feed parameters: activity : The activity to add
inherited
follow(FlatFeed flatFeed, {int? activityCopyLimit}) Future<void>
Follows the given target feed
inherited
followers({Iterable<FeedId>? feedIds, int? limit, int? offset, String? session}) Future<List<Follow>>
List the followers of this feed
inherited
following({Iterable<FeedId>? filter, int? limit, int? offset, String? session}) Future<List<Follow>>
List which feeds this feed is following
inherited
followStats({List<String>? followingSlugs, List<String>? followerSlugs}) Future<FollowStats>
Retrieves the number of followers and following feed stats of the current feed.
inherited
getActivities({int? limit, int? offset, String? session, Filter? filter, String? ranking}) Future<List<Activity>>
Retrieve activities
getActivityDetail(String activityId) Future<Activity>
Retrieves one activity from a feed
getEnrichedActivities<A, Ob, T, Or>({int? limit, int? offset, String? session, Filter? filter, EnrichmentFlags? flags, String? ranking}) Future<List<GenericEnrichedActivity<A, Ob, T, Or>>>
Retrieve activities with reaction enrichment
getEnrichedActivityDetail<A, Ob, T, Or>(String activityId) Future<GenericEnrichedActivity<A, Ob, T, Or>>
Retrieves one enriched activity from a feed
getPaginatedEnrichedActivities<A, Ob, T, Or>({int? limit, int? offset, String? session, Filter? filter, EnrichmentFlags? flags, String? ranking}) Future<PaginatedActivities<A, Ob, T, Or>>
final paginated = await flatFeed.getPaginatedEnrichedActivities(); final nextParams = parseNext(paginated.next!); //parse next page await flatFeed.getPaginatedEnrichedActivities(limit: nextParams.limit,filter: nextParams.idLT);
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
personalizedFeed({int? limit, int? offset, String? session, Filter? filter, ActivityMarker? marker, EnrichmentFlags? flags, String? ranking}) Future<PersonalizedFeed>
Retrieve a personalized feed for the currentUser i.e. a feed of based on user's activities.
removeActivityByForeignId(String foreignId) Future<void>
Remove an Activity by referencing its foreign_id
inherited
removeActivityById(String id) Future<void>
Removes the activity by activityId or foreignId
inherited
replaceActivityToTargets(ActivityUpdate update, Iterable<FeedId> newTargets) Future<void>
Replace Activity.to Targets Usage:
inherited
subscribe<A, Ob, T, Or>(void callback(RealtimeMessage<A, Ob, T, Or>? message)) Future<Subscription>
Subscribes to any changes in the feed, return a Subscription
inherited
toString() String
A string representation of this object.
inherited
unfollow(FlatFeed flatFeet, {bool keepHistory = false}) Future<void>
Unfollow the given feed
inherited
updateActivitiesByForeignId(Iterable<ActivityUpdate> updates) Future<List<Activity>>
Update Activities By ForeignId
inherited
updateActivitiesById(Iterable<ActivityUpdate> updates) Future<List<Activity>>
Update Activities By Id
inherited
updateActivityByForeignId({required String foreignId, required DateTime time, Map<String, Object>? set, List<String>? unset}) Future<Activity>
Update Activity.foreignId By ForeignId
inherited
updateActivityById({required String id, Map<String, Object>? set, List<String>? unset}) Future<Activity>
Partial update by activity ID
inherited
updateActivityToTargets(ActivityUpdate update, Iterable<FeedId> add, Iterable<FeedId> remove) Future<void>
Updates an activity's Activity.to fields
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited