TimelineUserStoryConfiguration class

Configuration class for defining user-specific settings and callbacks for a timeline user story.

This class holds various parameters to customize the behavior and appearance of a user story timeline.

Annotations

Constructors

TimelineUserStoryConfiguration({required TimelineService service, required TimelineOptions optionsBuilder(BuildContext context), String userId = 'test_user', dynamic homeOpenPageBuilder(BuildContext context, Widget child, FloatingActionButton? button)?, dynamic postCreationOpenPageBuilder(BuildContext context, Widget child, IconButton? button)?, dynamic postViewOpenPageBuilder(BuildContext context, Widget child, IconButton? button)?, dynamic postOverviewOpenPageBuilder(BuildContext context, Widget child)?, dynamic onPostTap(BuildContext context, TimelinePost post)?, dynamic onUserTap(BuildContext context, String userId)?, Widget onPostDelete(BuildContext context, TimelinePost post)?, bool filterEnabled = false, Widget postWidgetBuilder(TimelinePost post)?, bool afterPostCreationGoHome = false, bool enablePostOverviewScreen = true, dynamic categorySelectionOpenPageBuilder(BuildContext context, Widget child)?})
Constructs a TimelineUserStoryConfiguration with the specified parameters.
const

Properties

afterPostCreationGoHome → bool
Boolean to enable redirect to home after post creation. If false, it will redirect to created post screen
final
categorySelectionOpenPageBuilder → (dynamic Function(BuildContext context, Widget child)?)
Open page builder function for the category selection page. This function accepts a BuildContext and a child widget.
final
enablePostOverviewScreen → bool
Boolean to enable timeline post overview screen before submitting
final
filterEnabled → bool
Determines whether filtering functionality is enabled for this user story timeline.
final
hashCode → int
The hash code for this object.
no setterinherited
homeOpenPageBuilder → (dynamic Function(BuildContext context, Widget child, FloatingActionButton? button)?)
Open page builder function for the home page. This function accepts a BuildContext, a child widget, and a FloatingActionButton which can route to the post creation page.
final
onPostDelete → (Widget Function(BuildContext context, TimelinePost post)?)
A callback function invoked when a post deletion is requested.
final
onPostTap → (dynamic Function(BuildContext context, TimelinePost post)?)
A callback function invoked when a timeline post is tapped.
final
onUserTap → (dynamic Function(BuildContext context, String userId)?)
A callback function invoked when the user's profile is tapped.
final
optionsBuilder → TimelineOptions Function(BuildContext context)
A function that builds TimelineOptions based on the given BuildContext.
final
postCreationOpenPageBuilder → (dynamic Function(BuildContext context, Widget child, IconButton? button)?)
Open page builder function for the post creation page. This function accepts a BuildContext, a child widget, and an IconButton which can route to the home page.
final
postOverviewOpenPageBuilder → (dynamic Function(BuildContext context, Widget child)?)
Open page builder function for the post overview page. This function accepts a BuildContext, a child widget, and an IconButton which can route to the home page.
final
postViewOpenPageBuilder → (dynamic Function(BuildContext context, Widget child, IconButton? button)?)
Open page builder function for the post view page. This function accepts a BuildContext, a child widget, and an IconButton which can route to the home page.
final
postWidgetBuilder → (Widget Function(TimelinePost post)?)
A function that builds a widget for a timeline post.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
service → TimelineService
The TimelineService responsible for fetching user story data.
final
userId → String
The ID of the user associated with this user story configuration.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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